generate project readme using langgraph 다운로드 - generate project readme using langgraph 소스 코드 다운로드

generate project readme using langgraph

기타 소스코드

1.0.0

다운로드

rdmgen

rdmgen 은 Amazon Bedrock 및 LangGraph를 사용하여 코드 저장소에 대한 고품질 README.md 파일을 자동으로 생성하는 Python CLI 도구입니다.

개요

이 프로젝트는 Amazon Bedrock, LangGraph 및 LangChain AWS 라이브러리를 사용하여 코드 저장소의 구조와 내용을 분석하고 포괄적인 README.md 파일을 생성합니다. 생성된 README는 프로젝트 개요, 설치 지침, 사용 예 및 저장소의 파일을 기반으로 하는 기타 관련 세부 정보를 제공합니다.

작업흐름

특징

자동화된 README 생성 : 더 이상 README 파일을 수동으로 작성할 필요가 없습니다! rdmgen 당신을 위해 열심히 일해 드립니다.
로컬 또는 원격 저장소 : 로컬 코드베이스 또는 원격 Git 저장소에 대한 README 파일 생성을 지원합니다.
실행 시각화 : 선택적으로 LangGraph 에이전트의 실행 흐름을 시각화하는 다이어그램을 생성합니다.
사용자 정의 가능한 출력 : 생성된 README.md 파일을 지정한 디렉터리에 씁니다.

설치

참고: python >= 3.9 필요합니다. python --version 으로 이를 확인할 수 있습니다. 기본 환경에 필수 버전이 없는 경우 필수 버전으로 가상 환경을 생성하고 "옵션 1"을 사용하여 설치하세요.

옵션 1: pip 사용

저장소를 복제한 후 pip를 사용하여 패키지를 설치할 수 있습니다.

 pip install .

옵션 2: 메이크파일

일부 레시피가 포함된 Makefile은 Linux/MacOS에서 사용할 수 있습니다. 전용 Python venv를 생성하고 가상 환경에 rdmgen 설치하려면 다음을 실행합니다.

 make all

가상 환경의 이름은 기본적으로 .venv 이며 저장소와 동일한 디렉터리에 있습니다.

이제 다음 명령을 실행하여 환경을 활성화하십시오.

 source .venv/bin/activate

venv 정리 및 제거와 같은 더 많은 make 레시피를 보려면 make help 의 출력을 확인하세요.

용법

전제 조건

AWS 자격 증명 : cli 명령을 실행하여 README 파일을 생성하기 전에 AWS 자격 증명이 필요합니다. AWS 환경(예: SageMaker 노트북 인스턴스) 내에서 이를 실행하는 경우 2단계로 진행하여 연결된 IAM 역할에 올바른 권한이 부여되었는지 확인할 수 있습니다.
IAM 권한 : IAM 사용자 또는 역할은 선택한 모델에 대해 최소한 다음 권한을 가지고 있어야 합니다(리소스 *를 모델 ID로 교체).

{
    "Version" : " 2012-10-17 " ,
    "Statement" : [
        {
            "Sid" : " VisualEditor " ,
            "Effect" : " Allow " ,
            "Action" : [
                " bedrock:InvokeModel " ,
                " bedrock:InvokeModelWithResponseStream "
            ],
            "Resource" : " * "
        }
    ]
}

Amazon Bedrock의 모델 액세스 : Amazon Bedrock Service의 AWS 콘솔을 통해 선택한 모델에 액세스할 수 있는지 확인하십시오.

참고: 이 프로젝트는 Amazon Bedrock의 Claude 3 소네트 anthropic.claude-3-sonnet-20240229-v1:0 사용합니다. 액세스 권한이 있는지 확인하세요. 모델 ID를 변경하려면 src/rdmgen/constants.py 에서 업데이트하고 패키지를 다시 설치하세요.

명령

저장소에 대한 README.md 파일을 생성하려면 cli 명령을 실행하십시오.

 rdmgen <REPO_PATH> --out <OUTPUT_FOLDER>

<REPO_PATH> : 로컬 복제/디렉토리 또는 원격 Git URL일 수 있습니다.
<OUTPUT_FOLDER> : 출력 README.md 파일을 저장할 경로입니다. 지정하지 않으면 소스코드와 동일한 디렉터리에 파일이 저장된다.

선택적인 --diagram 플래그를 전달하여 에이전트의 플로우차트를 생성하여 에이전트가 실행한 단계를 확인할 수 있습니다.

예

이 저장소에서는 테스트를 위해 다음 두 가지 예를 사용할 수 있습니다.

 rdmgen test_data/hello_world

 rdmgen test_data/sensor_extraction --out ./output

GitHub의 소규모 원격 저장소 예:

 rdmgen https://github.com/pypa/sampleproject --out output/sampleproject --diagram

제한 사항

rdmgen 유틸리티는 현재 중소 규모 저장소에서 작동합니다. src/constants.py 에 정의된 대규모 저장소에 대해 다음과 같은 조정 가능한 제한 사항을 고려하세요.

Bedrock 런타임 클라이언트에 구성으로 전달되는 Amazon Bedrock read-timeout , 자세한 내용: https://repost.aws/knowledge-center/bedrock-large-model-read-timeouts
그래프를 호출할 때 구성에 전달되는 LangGraph recursion_limit . 자세한 내용: https://langchain-ai.github.io/langgraph/how-tos/recursion-limit/?h=recursion

개발

개발 및 확장을 위해 이 프로젝트에서는 종속성 관리를 위해 Poetry를 사용합니다. 패키지와 종속성을 설치하려면 poem을 설치한 후 다음을 실행하세요.

 poetry lock 
poetry install

보안

자세한 내용은 기여를 참조하세요.

기여

기여를 환영합니다! 개선 사항이나 버그 수정 사항이 있는 경우 문제를 열거나 풀 요청을 제출해 주세요.

잠재적인 개선 사항:

읽을 파일을 결정하는 도구를 추가합니다. 즉, 중요하지 않은 파일을 읽는 것을 선택적으로 만듭니다.
각 README 섹션에 대해 파일을 반복적으로 읽습니다. 즉, 먼저 README 템플릿을 생성한 다음 각 섹션을 추가로 반복하여 해당 특정 섹션에 콘텐츠를 제공할 수 있는 파일만 읽습니다. 아마도 다음과 같은 패턴일 것입니다: https://langchain-ai.github.io/langgraph/tutorials/plan-and-execute/plan-and-execute/