š§° feat(project): adiciona Makefile e melhora a documentacao de setup #7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
LAMP-LUCAS
added a commit
that referenced
this pull request
Sep 17, 2025
* Feature/estrutura inicial | Estrutura inicial completa da AutoSINAPI API com FastAPI, Docker e Kong (#3) * chore: adiciona configuraĆ§Ć£o inicial do projeto * chore(infra): configura ambiente de desenvolvimento com Docker e Kong * feat(api): implementa estrutura inicial da API com FastAPI * feat(worker): adiciona configuraĆ§Ć£o do Celery para tarefas em background * docs: adiciona documentaĆ§Ć£o inicial e padrƵes de nomenclatura * chore: adiciona arquivo de exemplo para variĆ”veis de ambiente * fixup! chore(infra): configura ambiente de desenvolvimento com Docker e Kong * Feature/correĆ§Ć£o docker e api | š CorreƧƵes e ExpansƵes na Arquitetura da API AutoSINAPI (#4) * chore: adiciona configuraĆ§Ć£o inicial do projeto * chore(infra): configura ambiente de desenvolvimento com Docker e Kong * feat(api): implementa estrutura inicial da API com FastAPI * feat(worker): adiciona configuraĆ§Ć£o do Celery para tarefas em background * docs: adiciona documentaĆ§Ć£o inicial e padrƵes de nomenclatura * chore: adiciona arquivo de exemplo para variĆ”veis de ambiente * fixup! chore(infra): configura ambiente de desenvolvimento com Docker e Kong * fix(docker): Adiciona permissĆ£o de execuĆ§Ć£o ao script de inicializaĆ§Ć£o do DB * feat(project): Refatora arquitetura e adiciona mĆ³dulos de BI Esta refatoraĆ§Ć£o completa moderniza a arquitetura do projeto, introduzindo modularidade e novas funcionalidades de Business Intelligence. Principais alteraƧƵes: - CentralizaĆ§Ć£o de configuraƧƵes com Pydantic-Settings em 'api/config.py'. - AtualizaĆ§Ć£o de dependĆŖncias e adiĆ§Ć£o do mĆ³dulo 'autosinapi' via Git. - Melhoria na orquestraĆ§Ć£o do Docker com 'depends_on' e 'healthcheck' robustos. - RefatoraĆ§Ć£o completa dos mĆ³dulos da API ('crud', 'main', 'schemas') para usar a nova configuraĆ§Ć£o e desacoplar a lĆ³gica. - AdiĆ§Ć£o de trĆŖs novos endpoints de BI: - AnĆ”lise de Estrutura (Bill of Materials) - CĆ”lculo de Hora-Homem - Curva ABC de Insumos * feat(bi): Adiciona endpoint de otimizaĆ§Ć£o de custo Cria o endpoint /bi/composicao/{codigo}/otimizar que retorna os N insumos de maior impacto financeiro em uma composiĆ§Ć£o, reutilizando a lĆ³gica do BOM. * feat(bi): Adiciona endpoint de anĆ”lise de custo histĆ³rico Cria o endpoint /bi/item/{tipo_item}/{codigo}/historico para visualizar a variaĆ§Ć£o de preƧo/custo de um item ao longo do tempo. Adiciona a dependĆŖncia python-dateutil para manipulaĆ§Ć£o de datas. * docs(project): Atualiza documentaĆ§Ć£o e adiciona guia de contribuiĆ§Ć£o - Renomeia nomenclaturas.md para CONTRIBUTING.md e expande o conteĆŗdo. - Atualiza o README.md com as novas funcionalidades de BI. - Adiciona o WorkPlan.md com o plano para as prĆ³ximas funcionalidades. * fix(infra): Corrige inicializaĆ§Ć£o e configuraĆ§Ć£o do ambiente Docker' -m 'Este commit corrige uma sĆ©rie de problemas que impediam a inicializaĆ§Ć£o completa e estĆ”vel do ambiente Docker, especialmente relacionados Ć configuraĆ§Ć£o do Kong e suas dependĆŖncias. (#5) - **`docker-compose.yml`**: - **Uso de Imagem Customizada:** Os serviƧos `kong` e `kong-migrations` passam a usar uma imagem construĆda localmente (`build: ./kong/`) em vez da imagem pĆŗblica, permitindo a customizaĆ§Ć£o necessĆ”ria. - **CorreĆ§Ć£o de Healthcheck:** O `healthcheck` do serviƧo `sinapi_db` foi ajustado para verificar o usuĆ”rio e banco de dados corretos (`kong`), garantindo que o status de saĆŗde do banco de dados seja verificado corretamente. - **CorreĆ§Ć£o de Script de MigraĆ§Ć£o:** A sintaxe do laƧo `until` no comando do `kong-migrations` foi corrigida com a adiĆ§Ć£o da clĆ”usula `do`, resolvendo um erro de shell que bloqueava a inicializaĆ§Ć£o. - **Melhora no Logging:** O comando de bootstrap das migraƧƵes foi alterado para `kong migrations bootstrap --vv`, ativando o modo verbose para facilitar a depuraĆ§Ć£o de problemas de inicializaĆ§Ć£o. - **`kong/Dockerfile` (Novo):** - **CriaĆ§Ć£o de Imagem Customizada:** Um novo `Dockerfile` para o Kong foi criado para adicionar dependĆŖncias que nĆ£o existem na imagem oficial. - **InstalaĆ§Ć£o do `postgresql-client`:** Adiciona o cliente do PostgreSQL, essencial para que o script de migraĆ§Ć£o possa usar o comando `pg_isready` para verificar o status do banco de dados. - **Gerenciamento de PermissƵes:** Utiliza `USER root` para instalar as dependĆŖncias e retorna para `USER kong` ao final, seguindo as boas prĆ”ticas de seguranƧa para evitar a execuĆ§Ć£o do container com privilĆ©gios de root. - **`Dockerfile` (API):** - **AdiĆ§Ć£o do Git:** O `git` foi adicionado Ć imagem da API para permitir a instalaĆ§Ć£o de dependĆŖncias diretamente de repositĆ³rios Git, se necessĆ”rio. - **`docker/db/multiple-databases.sh`**: - **FormataĆ§Ć£o:** Adicionada uma nova linha ao final do arquivo para seguir as convenƧƵes de formataĆ§Ć£o de arquivos de texto. * feat(project): adiciona Makefile e melhora a documentacao de setup (#7) * Fix/db init script execution | š§© fix(infra): corrige execuĆ§Ć£o do script de inicializaĆ§Ć£o do banco de dados (#8) * fix(infra): Resolve o erro 'nĆ£o Ć© possĆvel executar: arquivo necessĆ”rio nĆ£o encontrado' na configuraĆ§Ć£o do banco de dados Docker * fix(infra): corrige execucao do script de inicializacao do banco de dados * fix(infra): ajusta chamada da tarefa populate_sinapi_task no Makefile para incluir configuracoes de db e sinapi * docs(project): adiciona documentacao para administracao e uso da API * Fix/db init script execution | š ļø CorreƧƵes na infraestrutura e melhorias no processo de carga de dados do SINAPI (#9) * fix(infra): Resolve o erro 'nĆ£o Ć© possĆvel executar: arquivo necessĆ”rio nĆ£o encontrado' na configuraĆ§Ć£o do banco de dados Docker * fix(infra): corrige execucao do script de inicializacao do banco de dados * fix(infra): ajusta chamada da tarefa populate_sinapi_task no Makefile para incluir configuracoes de db e sinapi * docs(project): adiciona documentacao para administracao e uso da API * feat(etl): implementa bypass de arquivo local para ETL do SINAPI Este commit introduz a capacidade de popular o banco de dados SINAPI usando arquivos .zip locais, ignorando a etapa de download. - Configurado o mapeamento de volume `autosinapi_downloads` no `docker-compose.yml` para os serviƧos `api` e `celery_worker`. - Atualizado o `README.md` com instruƧƵes detalhadas sobre como usar arquivos SINAPI locais, incluindo a estrutura de subdiretĆ³rios `AAAA_MM`. fix(infra): resolve problemas de ambiente Docker e acesso Ć API Este commit corrige vĆ”rios problemas crĆticos de infraestrutura e acesso Ć API: - Corrigido o comando `kong-migrations` no `docker-compose.yml` para importar corretamente a configuraĆ§Ć£o declarativa do Kong a partir de `kong.yml`. Isso resolve os erros de "no Route matched". - Revertido o `kong/kong.yml` para usar a rota genĆ©rica `/`. - Depurado e confirmado a resoluĆ§Ć£o do erro `TooManyRedirects` durante o download do ETL (pelo uso de arquivos locais). - Depurado e confirmado a resoluĆ§Ć£o do `psycopg2.OperationalError` na API (garantindo reinĆcios limpos do Docker). Isso garante que a aplicaĆ§Ć£o esteja totalmente funcional, com a populaĆ§Ć£o de dados e o acesso Ć API funcionando de ponta a ponta. * feat(api, docs): Melhora busca e documentaĆ§Ć£o da API (#10) Este commit introduz duas melhorias principais: 1. RefatoraĆ§Ć£o da Busca de ComposiƧƵes (crud.py): * A lĆ³gica de busca agora divide a string de consulta em palavras-chave independentes. * Para cada palavra-chave Ć© aplicado um ILIKE, garantindo resultados mais precisos e flexĆveis. * A query SQL Ć© montada dinamicamente para otimizar a performance. 2. AtualizaĆ§Ć£o da DocumentaĆ§Ć£o (user.md, README.md): * Foram adicionados exemplos de curl para todos os endpoints na documentaĆ§Ć£o do usuĆ”rio. * O cabeƧalhe de autenticaĆ§Ć£o foi corrigido para X-API-KEY nos exemplos. * A documentaĆ§Ć£o agora estĆ” mais clara e fĆ”cil de usar para novos desenvolvedores.
LAMP-LUCAS
added a commit
that referenced
this pull request
Sep 17, 2025
* Feature/estrutura inicial | Estrutura inicial completa da AutoSINAPI API com FastAPI, Docker e Kong (#3) * chore: adiciona configuraĆ§Ć£o inicial do projeto * chore(infra): configura ambiente de desenvolvimento com Docker e Kong * feat(api): implementa estrutura inicial da API com FastAPI * feat(worker): adiciona configuraĆ§Ć£o do Celery para tarefas em background * docs: adiciona documentaĆ§Ć£o inicial e padrƵes de nomenclatura * chore: adiciona arquivo de exemplo para variĆ”veis de ambiente * fixup! chore(infra): configura ambiente de desenvolvimento com Docker e Kong * Feature/correĆ§Ć£o docker e api | š CorreƧƵes e ExpansƵes na Arquitetura da API AutoSINAPI (#4) * chore: adiciona configuraĆ§Ć£o inicial do projeto * chore(infra): configura ambiente de desenvolvimento com Docker e Kong * feat(api): implementa estrutura inicial da API com FastAPI * feat(worker): adiciona configuraĆ§Ć£o do Celery para tarefas em background * docs: adiciona documentaĆ§Ć£o inicial e padrƵes de nomenclatura * chore: adiciona arquivo de exemplo para variĆ”veis de ambiente * fixup! chore(infra): configura ambiente de desenvolvimento com Docker e Kong * fix(docker): Adiciona permissĆ£o de execuĆ§Ć£o ao script de inicializaĆ§Ć£o do DB * feat(project): Refatora arquitetura e adiciona mĆ³dulos de BI Esta refatoraĆ§Ć£o completa moderniza a arquitetura do projeto, introduzindo modularidade e novas funcionalidades de Business Intelligence. Principais alteraƧƵes: - CentralizaĆ§Ć£o de configuraƧƵes com Pydantic-Settings em 'api/config.py'. - AtualizaĆ§Ć£o de dependĆŖncias e adiĆ§Ć£o do mĆ³dulo 'autosinapi' via Git. - Melhoria na orquestraĆ§Ć£o do Docker com 'depends_on' e 'healthcheck' robustos. - RefatoraĆ§Ć£o completa dos mĆ³dulos da API ('crud', 'main', 'schemas') para usar a nova configuraĆ§Ć£o e desacoplar a lĆ³gica. - AdiĆ§Ć£o de trĆŖs novos endpoints de BI: - AnĆ”lise de Estrutura (Bill of Materials) - CĆ”lculo de Hora-Homem - Curva ABC de Insumos * feat(bi): Adiciona endpoint de otimizaĆ§Ć£o de custo Cria o endpoint /bi/composicao/{codigo}/otimizar que retorna os N insumos de maior impacto financeiro em uma composiĆ§Ć£o, reutilizando a lĆ³gica do BOM. * feat(bi): Adiciona endpoint de anĆ”lise de custo histĆ³rico Cria o endpoint /bi/item/{tipo_item}/{codigo}/historico para visualizar a variaĆ§Ć£o de preƧo/custo de um item ao longo do tempo. Adiciona a dependĆŖncia python-dateutil para manipulaĆ§Ć£o de datas. * docs(project): Atualiza documentaĆ§Ć£o e adiciona guia de contribuiĆ§Ć£o - Renomeia nomenclaturas.md para CONTRIBUTING.md e expande o conteĆŗdo. - Atualiza o README.md com as novas funcionalidades de BI. - Adiciona o WorkPlan.md com o plano para as prĆ³ximas funcionalidades. * fix(infra): Corrige inicializaĆ§Ć£o e configuraĆ§Ć£o do ambiente Docker' -m 'Este commit corrige uma sĆ©rie de problemas que impediam a inicializaĆ§Ć£o completa e estĆ”vel do ambiente Docker, especialmente relacionados Ć configuraĆ§Ć£o do Kong e suas dependĆŖncias. (#5) - **`docker-compose.yml`**: - **Uso de Imagem Customizada:** Os serviƧos `kong` e `kong-migrations` passam a usar uma imagem construĆda localmente (`build: ./kong/`) em vez da imagem pĆŗblica, permitindo a customizaĆ§Ć£o necessĆ”ria. - **CorreĆ§Ć£o de Healthcheck:** O `healthcheck` do serviƧo `sinapi_db` foi ajustado para verificar o usuĆ”rio e banco de dados corretos (`kong`), garantindo que o status de saĆŗde do banco de dados seja verificado corretamente. - **CorreĆ§Ć£o de Script de MigraĆ§Ć£o:** A sintaxe do laƧo `until` no comando do `kong-migrations` foi corrigida com a adiĆ§Ć£o da clĆ”usula `do`, resolvendo um erro de shell que bloqueava a inicializaĆ§Ć£o. - **Melhora no Logging:** O comando de bootstrap das migraƧƵes foi alterado para `kong migrations bootstrap --vv`, ativando o modo verbose para facilitar a depuraĆ§Ć£o de problemas de inicializaĆ§Ć£o. - **`kong/Dockerfile` (Novo):** - **CriaĆ§Ć£o de Imagem Customizada:** Um novo `Dockerfile` para o Kong foi criado para adicionar dependĆŖncias que nĆ£o existem na imagem oficial. - **InstalaĆ§Ć£o do `postgresql-client`:** Adiciona o cliente do PostgreSQL, essencial para que o script de migraĆ§Ć£o possa usar o comando `pg_isready` para verificar o status do banco de dados. - **Gerenciamento de PermissƵes:** Utiliza `USER root` para instalar as dependĆŖncias e retorna para `USER kong` ao final, seguindo as boas prĆ”ticas de seguranƧa para evitar a execuĆ§Ć£o do container com privilĆ©gios de root. - **`Dockerfile` (API):** - **AdiĆ§Ć£o do Git:** O `git` foi adicionado Ć imagem da API para permitir a instalaĆ§Ć£o de dependĆŖncias diretamente de repositĆ³rios Git, se necessĆ”rio. - **`docker/db/multiple-databases.sh`**: - **FormataĆ§Ć£o:** Adicionada uma nova linha ao final do arquivo para seguir as convenƧƵes de formataĆ§Ć£o de arquivos de texto. * feat(project): adiciona Makefile e melhora a documentacao de setup (#7) * Fix/db init script execution | š§© fix(infra): corrige execuĆ§Ć£o do script de inicializaĆ§Ć£o do banco de dados (#8) * fix(infra): Resolve o erro 'nĆ£o Ć© possĆvel executar: arquivo necessĆ”rio nĆ£o encontrado' na configuraĆ§Ć£o do banco de dados Docker * fix(infra): corrige execucao do script de inicializacao do banco de dados * fix(infra): ajusta chamada da tarefa populate_sinapi_task no Makefile para incluir configuracoes de db e sinapi * docs(project): adiciona documentacao para administracao e uso da API * Fix/db init script execution | š ļø CorreƧƵes na infraestrutura e melhorias no processo de carga de dados do SINAPI (#9) * fix(infra): Resolve o erro 'nĆ£o Ć© possĆvel executar: arquivo necessĆ”rio nĆ£o encontrado' na configuraĆ§Ć£o do banco de dados Docker * fix(infra): corrige execucao do script de inicializacao do banco de dados * fix(infra): ajusta chamada da tarefa populate_sinapi_task no Makefile para incluir configuracoes de db e sinapi * docs(project): adiciona documentacao para administracao e uso da API * feat(etl): implementa bypass de arquivo local para ETL do SINAPI Este commit introduz a capacidade de popular o banco de dados SINAPI usando arquivos .zip locais, ignorando a etapa de download. - Configurado o mapeamento de volume `autosinapi_downloads` no `docker-compose.yml` para os serviƧos `api` e `celery_worker`. - Atualizado o `README.md` com instruƧƵes detalhadas sobre como usar arquivos SINAPI locais, incluindo a estrutura de subdiretĆ³rios `AAAA_MM`. fix(infra): resolve problemas de ambiente Docker e acesso Ć API Este commit corrige vĆ”rios problemas crĆticos de infraestrutura e acesso Ć API: - Corrigido o comando `kong-migrations` no `docker-compose.yml` para importar corretamente a configuraĆ§Ć£o declarativa do Kong a partir de `kong.yml`. Isso resolve os erros de "no Route matched". - Revertido o `kong/kong.yml` para usar a rota genĆ©rica `/`. - Depurado e confirmado a resoluĆ§Ć£o do erro `TooManyRedirects` durante o download do ETL (pelo uso de arquivos locais). - Depurado e confirmado a resoluĆ§Ć£o do `psycopg2.OperationalError` na API (garantindo reinĆcios limpos do Docker). Isso garante que a aplicaĆ§Ć£o esteja totalmente funcional, com a populaĆ§Ć£o de dados e o acesso Ć API funcionando de ponta a ponta. * feat(api, docs): Melhora busca e documentaĆ§Ć£o da API (#10) Este commit introduz duas melhorias principais: 1. RefatoraĆ§Ć£o da Busca de ComposiƧƵes (crud.py): * A lĆ³gica de busca agora divide a string de consulta em palavras-chave independentes. * Para cada palavra-chave Ć© aplicado um ILIKE, garantindo resultados mais precisos e flexĆveis. * A query SQL Ć© montada dinamicamente para otimizar a performance. 2. AtualizaĆ§Ć£o da DocumentaĆ§Ć£o (user.md, README.md): * Foram adicionados exemplos de curl para todos os endpoints na documentaĆ§Ć£o do usuĆ”rio. * O cabeƧalhe de autenticaĆ§Ć£o foi corrigido para X-API-KEY nos exemplos. * A documentaĆ§Ć£o agora estĆ” mais clara e fĆ”cil de usar para novos desenvolvedores. * docs(release): Prepara documentaĆ§Ć£o para o release v0.1.0-beta.0 * chore(license): Altera a licenƧa para GPLv3 e atualiza dependĆŖncia
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
š DescriĆ§Ć£o do PR
Este PR introduz melhorias significativas na experiĆŖncia de desenvolvimento e auto-hospedagem do projeto autoSINAPI API, com foco em automaĆ§Ć£o de tarefas e clareza na documentaĆ§Ć£o.
šØ AlteraƧƵes Realizadas
ā Novo
MakefileAdiciona um painel de controle via
make, simplificando comandos essenciais para gerenciamento do ambiente Docker:make upmake downmake populate-dbmake logs-apimake logs-kongmake statusš AtualizaĆ§Ć£o do
README.mdEssa atualizaĆ§Ć£o torna o projeto mais acessĆvel, profissional e fĆ”cil de usar ā tanto para novos colaboradores quanto para usuĆ”rios que desejam auto-hospedar a soluĆ§Ć£o.