get-sinapi 3.1.0__py3-none-any.whl

get_sinapi-3.1.0.dist-info/METADATA

@@ -0,0 +1,236 @@
+Metadata-Version: 2.4
+Name: get-sinapi
+Version: 3.1.0
+Summary: Pipeline rastreável de dados públicos do SINAPI/CAIXA
+Author: NR TECH
+License-Expression: MIT
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31
+Requires-Dist: curl-cffi>=0.7
+Requires-Dist: beautifulsoup4>=4.12
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: pandas>=2.2
+Requires-Dist: openpyxl>=3.1
+Requires-Dist: xlrd>=2.0
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: SQLAlchemy>=2.0
+Requires-Dist: fastapi>=0.110
+Requires-Dist: uvicorn[standard]>=0.27
+Requires-Dist: reportlab>=4.2
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Requires-Dist: requests-mock>=1.12; extra == "dev"
+Requires-Dist: httpx>=0.27; extra == "dev"
+Dynamic: license-file
+
+<div align="center">
+
+<img src="assets/gets-inapi-hero.svg" alt="GET-SINAPI — plataforma privada para consulta e análise de custos SINAPI" width="100%">
+
+# GET-SINAPI
+
+### PLATAFORMA DESKTOP · CONSULTA SINAPI · ENGENHARIA DE CUSTOS
+
+Aplicação privada para Windows que transforma publicações oficiais da CAIXA/SINAPI em consultas, análises, comparações e orçamentos rastreáveis.
+
+![Python](https://img.shields.io/badge/Python-3.11%2B-1677C8?style=for-the-badge&logo=python&logoColor=white)
+![React](https://img.shields.io/badge/Frontend-React%20%2B%20Vite-087BCE?style=for-the-badge&logo=react&logoColor=white)
+![FastAPI](https://img.shields.io/badge/API-FastAPI-009688?style=for-the-badge&logo=fastapi&logoColor=white)
+![SQLite](https://img.shields.io/badge/Database-SQLite-21B8D5?style=for-the-badge&logo=sqlite&logoColor=white)
+![Windows](https://img.shields.io/badge/Platform-Windows-1677C8?style=for-the-badge&logo=windows&logoColor=white)
+
+**Dados oficiais. Processamento local. Decisões de engenharia com rastreabilidade.**
+
+</div>
+
+---
+
+## Visão geral
+
+O GET-SINAPI é um aplicativo desktop privado para Windows. Ele reúne uma interface React, uma API local FastAPI, processamento Python e persistência SQLite. O launcher inicia os serviços na própria máquina e abre a plataforma no navegador padrão; o usuário não precisa iniciar manualmente os servidores.
+
+O produto utiliza o PulseSINAPI como referência de experiência funcional, mas mantém pipeline e regras próprias para ingestão, qualidade, cálculo e rastreabilidade dos dados oficiais.
+
+> **Distribuição atual:** executável Windows privado. A aplicação não é um serviço web público nem possui autenticação centralizada na nuvem.
+
+## Funcionalidades disponíveis na aplicação
+
+- Dashboard com indicadores derivados da base efetivamente carregada.
+- Consulta de insumos com pesquisa, filtros e paginação.
+- Consulta de composições e detalhamento de componentes e coeficientes.
+- Comparação de preços por UF e competência, conforme cobertura disponível.
+- Cesta de orçamento e cálculo de totais.
+- Histórico das competências presentes na base local.
+- Relatórios e exportações disponibilizados pela versão atual.
+- Atualização da base com acompanhamento de estado e progresso.
+- Integridade, auditoria e informações de origem dos dados.
+- Gestão local de contas de acesso.
+
+A disponibilidade de resultados depende das competências e dos arquivos oficiais efetivamente baixados, processados e validados. O sistema não deve apresentar dados ausentes como se fossem preços iguais a zero.
+
+## Capturas e arquitetura
+
+<p align="center">
+  <img src="assets/gets-inapi-architecture.svg" alt="Arquitetura local do GET-SINAPI: launcher Windows, React, FastAPI, Python e SQLite" width="100%">
+</p>
+
+A arquitetura é inteiramente local na distribuição atual:
+
+| Componente | Tecnologia | Responsabilidade |
+|---|---|---|
+| Aplicação desktop | Python / PyInstaller | Inicialização e encerramento dos serviços |
+| Interface | React + Vite + TypeScript | Navegação, filtros, tabelas e visualizações |
+| API | FastAPI | Consultas, autenticação local e operações |
+| Processamento | Python | Coleta, validação, normalização e cálculos |
+| Persistência | SQLite | Dados SINAPI e informações locais |
+| Autenticação | PBKDF2 + sessão local | Login e controle de contas neste computador |
+
+## Autenticação local
+
+O primeiro acesso permite configurar a conta administradora. O identificador pode ser o e-mail do usuário, acompanhado de uma senha com no mínimo 12 caracteres.
+
+- O primeiro usuário cadastrado recebe o perfil de administrador.
+- O administrador pode cadastrar outras contas locais pela área de gestão de acessos.
+- As senhas não são armazenadas em texto puro: o backend deriva o hash com PBKDF2-HMAC-SHA256 e salt individual.
+- A sessão local tem duração de até oito horas.
+- Os registros de autenticação são mantidos no arquivo `security/users.json`, dentro do diretório de dados da aplicação.
+
+**Limite importante:** as contas são locais e pertencem ao diretório de dados daquele computador. Cadastrar usuários em uma instalação não cria automaticamente contas nas instalações dos demais engenheiros. Ainda não há login centralizado, revogação remota, sincronização de contas ou compartilhamento central de orçamentos.
+
+## Armazenamento e diretório de dados
+
+A aplicação utiliza SQLite local. O diretório de dados pode ser definido por configuração de ambiente; na distribuição desktop, o launcher prepara o ambiente de execução e mantém logs locais.
+
+Não compartilhe o arquivo de banco ou o diretório de autenticação contendo dados operacionais sem avaliar previamente as implicações de segurança e consistência. Para vários engenheiros trabalharem com a mesma base e os mesmos orçamentos, será necessária uma camada de sincronização central — não faz parte do modelo atual.
+
+## Instalação e utilização
+
+1. Baixe o pacote Windows disponibilizado na área de Releases ou no artefato de build autorizado.
+2. Extraia o ZIP em uma pasta local.
+3. Execute `GET-SINAPI-V3.exe`.
+4. No primeiro acesso, configure o usuário administrador e a senha.
+5. Nos acessos seguintes, entre com as credenciais locais.
+
+O launcher inicia a API e o frontend localmente, aguarda os serviços responderem e então abre a interface no navegador padrão.
+
+## Exportação em lote pelo terminal
+
+Além do executável desktop, o pacote Python disponibiliza a interface de terminal pelo comando `getsinapi`. O menu interativo permite selecionar:
+
+- Todas as categorias ou apenas insumos, composições e componentes.
+- Uma competência específica ou todas as competências carregadas.
+- Uma UF específica ou todas as UFs disponíveis.
+- Regime de desoneração e modalidade de encargos.
+- Pesquisa por código ou descrição.
+- Saída em Excel (.xlsx), CSV ou nos dois formatos.
+
+A exportação completa gera uma visão consolidada com os registros selecionados e arquivos/abas individualizados por categoria. No Excel, o consolidado e cada categoria ficam em abas próprias; no CSV, são gerados um arquivo consolidado e arquivos separados por categoria. Os CSVs usam UTF-8 com BOM e delimitador ponto e vírgula para melhor abertura no Excel em configurações regionais brasileiras.
+
+### Instalação e execução
+
+Após a publicação da versão que contém essa funcionalidade no PyPI:
+
+```powershell
+python -m pip install --upgrade get-sinapi
+getsinapi
+```
+
+Ou execute diretamente o menu de exportação:
+
+```powershell
+getsinapi export
+```
+
+O comando consulta a base SQLite local já carregada; não refaz o download dos pacotes oficiais a cada exportação. Na instalação desktop, utiliza o mesmo diretório de dados configurado pelo launcher. Em instalações independentes, defina `GETSINAPI_DATABASE_PATH` para apontar ao arquivo `getsinapi.sqlite3` correto. A funcionalidade de terminal não substitui nem altera o executável Windows.
+
+## Desenvolvimento local
+
+Requisitos: Python 3.11+ e Node.js 20+.
+
+### Backend
+
+```powershell
+py -3.11 -m venv .venv
+.\.venv\Scripts\Activate.ps1
+python -m pip install --upgrade pip
+pip install -e ".[dev]"
+$env:GETSINAPI_DATABASE_PATH = "data/getsinapi.sqlite3"
+uvicorn getsinapi.api.main:app --reload
+```
+
+API local: `http://127.0.0.1:8000`  
+Health check: `http://127.0.0.1:8000/api/health`  
+Documentação OpenAPI: `http://127.0.0.1:8000/docs`
+
+### Frontend
+
+Em outro terminal:
+
+```powershell
+cd frontend
+npm install
+npm run dev
+```
+
+Frontend de desenvolvimento: `http://localhost:5173`. O Vite encaminha as chamadas `/api` para a API local.
+
+### Qualidade e testes
+
+```powershell
+ruff check .
+pytest -v
+```
+
+O workflow Windows também compila o frontend, empacota a aplicação com PyInstaller e executa um smoke test da interface e do endpoint de saúde antes de publicar o artefato.
+
+## Pipeline e integridade dos dados
+
+| Camada | Responsabilidade |
+|---|---|
+| Bronze | Preservação dos pacotes oficiais recebidos |
+| Staging | Extração controlada e inventário dos arquivos |
+| Silver | Normalização, tipagem e validação |
+| Gold | Estruturas consolidadas para consulta e análise |
+| Aplicação | Consulta, comparação, cálculo e orçamento |
+
+Princípios:
+
+- Publicações oficiais da CAIXA como fonte de referência.
+- Nenhum dado sintético em produção.
+- Distinção entre zero publicado, valor ausente e falha de extração.
+- Preservação de competência, UF, regime e origem.
+- Valores monetários e coeficientes tratados com precisão decimal.
+- Atualizações incrementais e idempotentes, preservando o histórico válido.
+- Rastreabilidade até publicação, arquivo e referência de origem, conforme metadados disponíveis.
+
+## Cobertura e limitações conhecidas
+
+- A cobertura histórica depende dos pacotes efetivamente publicados, coletados e processados.
+- Os layouts legados anteriores a 2025 exigem tratamento específico; não se deve presumir cobertura histórica integral.
+- O armazenamento é SQLite local.
+- A autenticação é local, sem provedor externo.
+- Não há sincronização de dados ou orçamentos entre computadores.
+- A distribuição atual é desktop Windows; uma versão web hospedada não faz parte do escopo vigente.
+
+## Stack tecnológica
+
+Python · React · TypeScript · Vite · FastAPI · SQLite · SQLAlchemy · Pandas · Pytest · Ruff · PyInstaller · GitHub Actions.
+
+## Licença e dados de terceiros
+
+O código-fonte é distribuído sob a licença MIT, conforme o arquivo [LICENSE](LICENSE). Essa licença não altera os direitos, termos de uso ou atribuição aplicáveis às publicações, marcas e dados de terceiros, incluindo os dados oficiais do SINAPI.
+
+---
+
+<div align="center">
+
+**GET-SINAPI**  
+NR TECH · Engenharia de Dados e Custos
+
+*Precisão na origem. Consistência no processamento. Confiança na consulta.*
+
+</div>

get_sinapi-3.1.0.dist-info/RECORD

@@ -0,0 +1,30 @@
+get_sinapi-3.1.0.dist-info/licenses/LICENSE,sha256=4fCQaRKEcEJSHX8SN_JdKPBjXkW1leC_yUS_zjurQR8,1073
+getsinapi/__init__.py,sha256=Zy2MBHENN3aiZdfJFZqXcM3bKj_ySZYMIFuvaerf-68,75
+getsinapi/bootstrap.py,sha256=SFH-jvWaSr1JkmIfBPf4-utACqZt9PDKgD2oMO06R08,16988
+getsinapi/cli.py,sha256=ZKUmfgdXq4E0QuegJllz-Ga2h-k91ddlw9MhBzbEiPU,8620
+getsinapi/config.py,sha256=HnLbH7CrzgHX9D5nXz1UDBctfRdjv7Nbak4L3sUmig4,2497
+getsinapi/domain.py,sha256=uOu8nAw6FSy_bAO0UmuYKP-swgEC92PvFYU2QUafzE4,2524
+getsinapi/exporter.py,sha256=SkxUUVqojyBDoyUyaWugFV6RinKNkjbgtfZZDJUO-KM,7332
+getsinapi/normalizers.py,sha256=NSWy6HuL2kdwZW6g_AQEDUT2qalsYci7VF3JYB-vUus,3053
+getsinapi/api/__init__.py,sha256=FKP77EwaRy0GY6zNwJxRA6PuHKg3f1SY9jeemA8DXiw,30
+getsinapi/api/main.py,sha256=tpzc3oM9ndhGE0KD--J50Z0h6SRgsRQYwPE92PUuLto,35454
+getsinapi/collectors/__init__.py,sha256=9GCabjqjrmyua9uo8hj6BgPAzXRZFN15d4CKVvLlCpo,36
+getsinapi/collectors/caixa.py,sha256=k3kbqF1VPdvn7WtdOnD0sUK0UfytXgIznDX56ekOHXA,15715
+getsinapi/collectors/history.py,sha256=lIQW5yMXRhtgocZDxNYKBz294k-c1SFZ9J3D1QWo8zU,9628
+getsinapi/extractors/__init__.py,sha256=O70YkubpldZzy-LeCTDtHme_dVYpUce_f-Rime5brj0,45
+getsinapi/extractors/compositions.py,sha256=x2ii1C8E73Os2dNSZxfQQVqScPFp9jlnvu53Cq370l0,7999
+getsinapi/extractors/price_tables.py,sha256=dSM_8lappkXeBX7H8ixVFUB93aTZOs2bmnJt3vvkTMw,5526
+getsinapi/extractors/reference_workbook.py,sha256=wDyAt1f9Cpq96EUaw2LpAMpa9rmfEPFzW7bw95rro20,1885
+getsinapi/extractors/sinapi_parser.py,sha256=ofjKonGIkAW3vYTEaThwqPInoCgBrhYcnVeq9d7zuow,5583
+getsinapi/extractors/workbooks.py,sha256=Hnsm7XiRDx26pO-fYjA6GPRLhCipTev91TgGC3r8pXk,4264
+getsinapi/pipeline/__init__.py,sha256=EphtqrqW5TyTPLuQYWRvlEbbHzFIpZSRZggFa29vxHc,57
+getsinapi/pipeline/normalize.py,sha256=I5MCDeISX328FeHzUSp41Uv_xAO2zHzN0ri7WFAKPnI,3926
+getsinapi/services/__init__.py,sha256=vxutxHvWi3VZ6xdSidX2l_1wA7XhfDzdEf256oy4Enc,55
+getsinapi/services/costing.py,sha256=0GdQlKUuKi3njDTS_m9p8R_6iBHONAZPOkzFnDbd3D4,11894
+getsinapi/storage/__init__.py,sha256=bwFN3OgkIVkvcYbyRdNg-9wMFRqP9PI9lQtrheu36dU,51
+getsinapi/storage/sqlite.py,sha256=B0xyM0hdPiJ6RDJEwBsJWbmx8sWOF6cTcODkFhSylyk,13841
+get_sinapi-3.1.0.dist-info/METADATA,sha256=ED4BPbHKJPF4wWkMHVAmvYU36YZzVYJM9_hwmSxxMVo,10832
+get_sinapi-3.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+get_sinapi-3.1.0.dist-info/entry_points.txt,sha256=PD_NKIXUh3Vlf85ffQUKfgFOHp6nmXo_6n3YGhl42Ns,49
+get_sinapi-3.1.0.dist-info/top_level.txt,sha256=yFeiD3DfV9KUnZLhD6VDRt4eQz0NhEnHtAMASFMfd8Q,10
+get_sinapi-3.1.0.dist-info/RECORD,,

get_sinapi-3.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

get_sinapi-3.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+getsinapi = getsinapi.cli:main

get_sinapi-3.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 NR Data Analysis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

get_sinapi-3.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+getsinapi

getsinapi/__init__.py

@@ -0,0 +1,2 @@
+"""GET-SINAPI: pipeline de dados do SINAPI/CAIXA."""
+__version__ = "3.1.0"

getsinapi/api/__init__.py

@@ -0,0 +1 @@
+"""API HTTP do GET-SINAPI."""