generate project readme using langgraph Download - generate project readme using langgraph Download do código-fonte

generate project readme using langgraph

Outro código-fonte

1.0.0

Baixar

rdmgen

rdmgen é uma ferramenta Python CLI para gerar automaticamente arquivos README.md de alta qualidade para repositórios de código usando Amazon Bedrock e LangGraph .

Visão geral

Este projeto usa as bibliotecas AWS Amazon Bedrock, LangGraph e LangChain para analisar a estrutura e o conteúdo de um repositório de código e gerar um arquivo README.md abrangente. O README gerado fornece uma visão geral do projeto, instruções de instalação, exemplos de uso e outros detalhes relevantes com base nos arquivos do repositório.

Fluxo de trabalho

Características

Geração automatizada de README : Chega de escrever arquivos README manualmente! rdmgen faz o trabalho duro para você.
Repositórios locais ou remotos : suporta a geração de arquivos README para bases de código locais ou repositórios Git remotos.
Visualização de execução : opcionalmente, gere um diagrama visualizando o fluxo de execução do agente LangGraph.
Saída personalizável : Grave o arquivo README.md gerado em qualquer diretório que você especificar.

Instalação

Observação: você precisa python >= 3.9 . Você pode verificar isso com python --version . Caso seu ambiente base não possua a versão necessária, crie um ambiente virtual com a versão necessária e utilize a “Opção 1” para instalar.

Opção 1: usando pip

Você pode instalar o pacote com pip após clonar o repositório.

 pip install .

Opção 2: Makefile

Um Makefile com algumas receitas está disponível para Linux/MacOS. Para criar um ambiente Python dedicado e instalar rdmgen no ambiente virtual, execute:

 make all

O ambiente virtual é denominado .venv por padrão e está localizado no mesmo diretório do repositório.

Agora execute o seguinte comando para ativar o ambiente:

 source .venv/bin/activate

Para mais receitas de make, como limpeza e remoção de venv, verifique o resultado de make help .

Uso

Pré-requisitos

Credenciais da AWS : antes de executar os comandos cli para gerar um arquivo README, as credenciais da AWS são necessárias. Se você estiver executando isso em um ambiente AWS (por exemplo, instância do SageMaker Notebook), poderá prosseguir para a etapa 2 para garantir que as permissões corretas sejam concedidas à função IAM anexada.
Permissões do IAM : o usuário ou função do IAM deve ter pelo menos as seguintes permissões no modelo selecionado (substitua o recurso * pelo(s) ID(s) do modelo):

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

Acesso ao modelo no Amazon Bedrock : certifique-se de ter acesso ao modelo selecionado por meio do Console AWS no Amazon Bedrock Service.

Nota: O projeto usa o soneto de Claude 3: anthropic.claude-3-sonnet-20240229-v1:0 do Amazon Bedrock. Por favor, certifique-se de ter acesso a ele. Se desejar alterar o ID do modelo, atualize-o em src/rdmgen/constants.py e reinstale o pacote.

Comandos

Para gerar um arquivo README.md para seu repositório, execute o comando cli:

 rdmgen <REPO_PATH> --out <OUTPUT_FOLDER>

<REPO_PATH> : pode ser um clone/diretório local ou uma URL Git remota.
<OUTPUT_FOLDER> : caminho para salvar o arquivo README.md de saída. Se não for especificado, o arquivo será salvo no mesmo diretório do código-fonte.

Você pode passar o sinalizador opcional --diagram para criar o fluxograma do agente para ver as etapas que ele executou.

Exemplos

Os dois exemplos a seguir estão disponíveis neste repositório para teste:

 rdmgen test_data/hello_world

 rdmgen test_data/sensor_extraction --out ./output

Exemplo de um pequeno repositório remoto no GitHub:

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

Limitações

O utilitário rdmgen funciona atualmente para repositórios pequenos e médios. Considere as seguintes limitações ajustáveis para repositórios grandes, que são definidas em src/constants.py :

Amazon Bedrock read-timeout , que é passado para o cliente de tempo de execução Bedrock como uma configuração, mais detalhes: https://repost.aws/knowledge-center/bedrock-large-model-read-timeouts
LangGraph recursion_limit , que é passado para a configuração ao invocar o gráfico. Mais detalhes: https://langchain-ai.github.io/langgraph/how-tos/recursion-limit/?h=recursion

Desenvolvimento

Para desenvolvimento e extensões, este projeto usa Poetry para gerenciamento de dependências. Para instalar o pacote e as dependências, instale o poet e execute:

 poetry lock 
poetry install

Segurança

Consulte CONTRIBUINDO para obter mais informações.

Contribuindo

Contribuições são bem-vindas! Abra um problema ou envie uma solicitação pull se tiver alguma melhoria ou correção de bug.

Potenciais melhorias:

Adicione uma ferramenta para decidir quais arquivos ler, ou seja, torne opcional a leitura de arquivos não importantes.
Leia os arquivos iterativamente para cada seção README. ou seja, primeiro crie um modelo README, depois percorra cada seção e leia apenas os arquivos que possam contribuir com conteúdo para aquela seção específica. Talvez um padrão como: https://langchain-ai.github.io/langgraph/tutorials/plan-and-execute/plan-and-execute/