Skip to content

Atualização de integração: uso de OPENAI_API_KEY via ambiente, ajuste de tokens, inclusão de Invoices e GPLv3#99

Merged
ualers2 merged 1 commit into
mainfrom
minha-feature
Sep 30, 2025
Merged

Atualização de integração: uso de OPENAI_API_KEY via ambiente, ajuste de tokens, inclusão de Invoices e GPLv3#99
ualers2 merged 1 commit into
mainfrom
minha-feature

Conversation

@ualers2
Copy link
Copy Markdown
Owner

@ualers2 ualers2 commented Sep 30, 2025

Descrição

  • Breve resumo das mudanças:
    • Adição de Back-End/Invoices/ ao .gitignore para evitar versionamento de invoices gerados.
    • Carregamento de OPENAI_API_KEY a partir de variáveis de ambiente no backend.
    • Ajuste na obtenção de tokens no fluxo de PR para não expor OPENAI_API_KEY extraído de tokens.
    • Inclusão do arquivo LICENSE.txt com a licença GNU GPL v3.
  • Explicação concisa do propósito geral do PR:
    • Melhorar segurança e redundância das chaves de API, centralizando-as em variáveis de ambiente.
    • Preparar o suporte a invoices geradas pela aplicação (estrutura de diretório ignorada pelo git).
    • Tornar a base de código compatível com uma licença aberta e explícita (GPL v3).

Mudanças Principais

  • Infraestrutura e configuração
    • Arquivo: .gitignore
    • Descrição: Adicionado Back-End/Invoices/ para evitar o versionamento de faturas geradas pela aplicação.
  • Backend/API
    • Arquivo: Back-End/api.py
    • Descrição: Carregamento de OPENAI_API_KEY a partir de OPENAI_API_KEY via ambiente (OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")). Mantém chaves sensíveis fora do código fonte.
  • Fluxo de autenticação/tokens
    • Arquivo: Back-End/api.py
    • Descrição: No fluxo de PR (prai), o retorno de get_tokens é ajustado para ignorar o valor relacionado ao OPENAI_API_KEY, mantendo apenas GITHUB_TOKEN, GITHUB_SECRET e REPOSITORY_NAME. Entrada anterior com OPENAI_API_KEY extraído de tokens foi removida.
  • Licenciamento
    • Arquivo: LICENSE.txt
    • Descrição: Adicionado o texto completo da GNU General Public License v3 (GPLv3) para esclarecer a licença do projeto.

Por que esta mudança?

  • Segurança e conformidade de licenciamento:
    • Centralizar chaves sensíveis em variáveis de ambiente reduz o risco de vazamento de credenciais no código e no controle de versões.
    • A introdução de OPENAI_API_KEY via env evita que a chave seja exposta em logs ou em locais de tokenização.
    • A adição da licença GPLv3 deixa explícita a governança de uso e distribuição do código.
  • Organização do repositório:
    • A inclusão do diretório Back-End/Invoices/ e sua exclusão do versionamento facilita o gerenciamento de faturas geradas pela aplicação.

Como testar

  1. Verifique o .gitignore:
    • Confirme que Back-End/Invoices/ está presente, garantindo que o diretório de faturas geradas não seja versionado.
  2. Variáveis de ambiente:
    • Defina OPENAI_API_KEY no ambiente (ex.: export OPENAI_API_KEY=...
    • Rode a aplicação e valide que OPENAI_API_KEY está sendo lida a partir da variável de ambiente, não do token retornado.
  3. Fluxo de tokens:
    • Execute o caminho que chama get_tokens no PR e confirme que o segundo valor retornado (OPENAI_API_KEY vindo de tokens) é ignorado, mantendo funcionamento com os demais tokens (GITHUB_TOKEN, GITHUB_SECRET, REPOSITORY_NAME).
  4. Licenciamento:
    • Verifique a presença de LICENSE.txt na raiz do projeto e confirme que o conteúdo corresponde à GPLv3.
  5. Integração/validação de invoices:
    • Caso haja geração de faturas, invoque o fluxo relevante e confirme que os arquivos são criados sob Back-End/Invoices/ (observando que o diretório está git-ignored).

Observações Adicionais (Opcional)

  • Dependências/ambiente:
    • É necessário que o ambiente de execução possua as variáveis de configuração (OPENAI_API_KEY, SMTP, etc.) conforme utilizado pelo código.
  • Licenciamento:
    • A inclusão do LICENSE.txt com GPLv3 pode impactar forks e usos comerciais; considere alinhar documentação interna e CONTRIBUTING.md conforme a política da equipe.
  • Próximos passos sugeridos:
    • Revisar se outras partes do código devem também obter OPENAI_API_KEY exclusivamente de variáveis de ambiente.
    • Atualizar a documentação de setup (README/CONTRIBUTING) para mencionar a necessidade de OPENAI_API_KEY no ambiente e a presença da licença GPLv3.

@ualers2 ualers2 changed the title Título do PR Atualização de integração: uso de OPENAI_API_KEY via ambiente, ajuste de tokens, inclusão de Invoices e GPLv3 Sep 30, 2025
@ualers2 ualers2 merged commit 5c443ec into main Sep 30, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant