Skip to main content

JTech Code Review Local

Sistema de revisão de código local que utiliza IA para fornecer sugestões de melhorias durante o processo de commit.

Requisitos

  • Python 3.12 ou superior
  • Git
  • Chave de API do Google (para Vertex AI)

Instalação

  1. Clone o repositório:
git clone <url-do-repositorio>
cd jtech-code-review
  1. Execute o script de instalação:
chmod +x install.sh
./install.sh
  1. Configure sua chave API do Google no arquivo .env:
GOOGLE_API_KEY=sua_chave_aqui

Uso

  1. Inicie o serviço:
./start_review_service.sh
  1. Faça suas alterações no código normalmente

  2. Ao tentar fazer um commit, o hook do git irá automaticamente:

    • Analisar as mudanças
    • Mostrar sugestões de melhorias
    • Perguntar se deseja prosseguir com o commit
  3. Para parar o serviço:

./stop_review_service.sh

Funcionalidades

  • Análise automática de código durante commits
  • Sugestões de melhorias usando IA
  • Suporte a diversos tipos de arquivos
  • Integração com git hooks

Opções Avançadas

Ignorar revisão temporariamente

Para fazer um commit sem revisão de código:

git commit --no-verify -m "sua mensagem"

Logs do serviço

Os logs do serviço podem ser encontrados em:

logs/review_service.log

Configurações personalizadas

Edite o arquivo .env para personalizar:

  • PORT: Porta do servidor local (padrão: 3000)
  • HOST: Host do servidor (padrão: 127.0.0.1)

Solução de Problemas

Serviço não inicia

  1. Verifique se a chave API está configurada corretamente
  2. Confirme que a porta 3000 está disponível
  3. Verifique os logs em logs/review_service.log

Hook não executa

  1. Verifique se o serviço está rodando (curl localhost:3000/health)
  2. Confirme que o arquivo .git/hooks/pre-commit tem permissão de execução
  3. Verifique se o git está configurado corretamente

Limitações Atuais

  • Atualmente otimizado para revisão de código Java
  • Requer conexão com internet para acesso à API do Google
  • Uma revisão por vez por arquivo

Contribuindo

  1. Fork o repositório
  2. Crie sua feature branch (git checkout -b feature/MinhaFeature)
  3. Commit suas mudanças (git commit -am 'Adicionando nova feature')
  4. Push para a branch (git push origin feature/MinhaFeature)
  5. Crie um Pull Request

Licença

Este projeto está licenciado sob a licença MIT - veja o arquivo LICENSE para detalhes.

Metadata

Release files for jtech-code-reviewer 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jtech-code-reviewer 1.0.1
File Size Uploaded Provenance
jtech_code_reviewer-1.0.1.tar.gz 14.8 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for jtech-code-reviewer 1.0.1
File Interpreter ABI Platform
jtech_code_reviewer-1.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 41.4 kB

Release files / jtech_code_reviewer-1.0.1.tar.gz

Download URL jtech_code_reviewer-1.0.1.tar.gz
Size 14.8 kB
Tags Source
SHA-256 checksum
How to use checksums
1259b2de14f1030c6f84b849f1830391ccdcfa3c35e851567c08bdfd3750c00e
BLAKE2b-256 checksum
How to use checksums
c5bae1d420cbfd1ce71a4196462d33e195b087420f276543d8999481b2e7112e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.12

Release files / jtech_code_reviewer-1.0.1-py3-none-any.whl

Download URL jtech_code_reviewer-1.0.1-py3-none-any.whl
Size 26.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
36ee77f2e5e056b6c4413860246c90dea8b7fe55236d595899d9c6f4d1b8ad11
BLAKE2b-256 checksum
How to use checksums
f4941dd3064f0cc9c02dc11f226d95a3e623ed79cc4b46d2d97363db3d77663a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.12

Security for jtech-code-reviewer 1.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page