RepoToTextForLLMs

hero

대규모 컨텍스트 LLM 사용에 맞춰 설계된 GitHub 저장소의 분석 과정을 자동화합니다. 이 Python 스크립트는 README 파일, 저장소 구조, 그리고 비(非)바이너리 파일 내용을 효율적으로 가져옵니다. 또한, 저장소 내용에 대한 추가 분석을 안내하는 사전 형식 지정 프롬프트가 포함된 구조화된 출력을 제공합니다.

주요 기능 (Features)

README 검색: README.md의 내용을 자동으로 추출하여 저장소에 대한 초기 통찰력을 제공합니다.
구조화된 저장소 탐색: 반복적인 순회(traversal) 방법을 통해 저장소 구조를 매핑하며, 재귀(recursion)의 한계 없이 철저한 커버리지를 보장합니다.
선택적 콘텐츠 추출: 파일에서 텍스트 내용을 검색하며, 바이너리 파일을 지능적으로 건너뛰어 분석 과정을 간소화합니다.

필수 조건 (Prerequisites)

RepoToTextForLLMs를 사용하려면 다음이 필요합니다:

시스템에 설치된 Python.
github Python 패키지.
환경 변수(GITHUB_TOKEN)로 설정된 GitHub Personal Access Token.

시작하기 (Getting Started)

Python과 필수 패키지 (PyGithub)가 설치되어 있는지 확인합니다:

pip install PyGithub tqdm

GitHub Personal Access Token을 환경 변수로 설정합니다:

GITHUB_TOKEN = os.getenv('GITHUB_TOKEN', 'YOUR TOKEN HERE')

사용 방법 (How to Use)

스크립트를 원하는 디렉토리에 배치합니다.
터미널에서 스크립트를 실행합니다:

python repototxt.py

프롬프트가 나타나면 GitHub 저장소 URL을 입력합니다. 스크립트는 해당 저장소를 처리하고, README, 구조, 파일 내용(바이너리 파일 제외) 및 분석 프롬프트를 포함한 그 결과를 출력합니다.

기여 (Contributing)

RepoToTextForLLMs에 대한 기여를 환영합니다. 풀 리퀘스트 제출, 이슈 보고, 개선 사항 제안 등 어떤 방식이든 여러분의 입력은 이 도구를 모두에게 더 좋게 만드는 데 도움이 됩니다.

라이선스 (License)

본 프로젝트는 MIT License 하에 라이선스가 부여됩니다.

GitHub 저장소 분석을 위한 RepoToTextForLLMs

요약

핵심 포인트

RepoToTextForLLMs

주요 기능 (Features)

필수 조건 (Prerequisites)

시작하기 (Getting Started)

사용 방법 (How to Use)

기여 (Contributing)

라이선스 (License)

댓글

RepoToTextForLLMs

주요 기능 (Features)

필수 조건 (Prerequisites)

시작하기 (Getting Started)

사용 방법 (How to Use)

기여 (Contributing)

라이선스 (License)