Metadata-Version: 2.5
Name: siopy-br
Version: 0.1.0
Summary: Brazilian federal budget (SIOP open data) and parliamentary amendments (Portal da Transparência) in pandas
Project-URL: Homepage, https://strategicprojects.github.io/siop/
Project-URL: Documentation, https://strategicprojects.github.io/siop/siopy/
Project-URL: Repository, https://github.com/StrategicProjects/siop
Project-URL: Issues, https://github.com/StrategicProjects/siop/issues
Project-URL: Changelog, https://github.com/StrategicProjects/siop/blob/main/siopy/NEWS.md
Author-email: André Leite <leite@castlab.org>, Marcos Wasiliew <marcos.wasiliew@gmail.com>, Hugo Vasconcelos <hugo.vasconcelos@ufpe.br>, Carlos Amorim <carlos.agaf@ufpe.br>, Diogo Bezerra <diogo.bezerra@ufpe.br>, Júlia Nascimento Barreto <juliabarreto@gd.seplag.pe.gov.br>
License: MIT License
        
        Copyright (c) 2026 siopy authors
        
        
        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.
License-File: LICENSE
Keywords: Brazil,Portal da Transparência,SIOP,dados abertos,emendas parlamentares,open-data,orçamento,pandas
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Requires-Dist: httpx>=0.27
Requires-Dist: pandas>=2.0
Requires-Dist: platformdirs>=4.0
Provides-Extra: dev
Requires-Dist: build>=1.0; extra == 'dev'
Requires-Dist: pytest>=8; extra == 'dev'
Requires-Dist: respx>=0.21; extra == 'dev'
Requires-Dist: ruff>=0.5; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.24; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest>=8; extra == 'test'
Requires-Dist: respx>=0.21; extra == 'test'
Description-Content-Type: text/markdown

# siopy <img src="https://raw.githubusercontent.com/StrategicProjects/siop/main/siopy/docs/figures/logo.svg" align="right" height="139" />

<!-- badges: start -->
![License](https://img.shields.io/badge/license-MIT-darkviolet.svg)
![](https://img.shields.io/badge/devel%20version-0.1.0-blue.svg)
[![siopy](https://github.com/StrategicProjects/siop/actions/workflows/siopy.yaml/badge.svg)](https://github.com/StrategicProjects/siop/actions/workflows/siopy.yaml)
[![PyPI](https://img.shields.io/pypi/v/siopy-br.svg)](https://pypi.org/project/siopy-br/)
<!-- badges: end -->

Orçamento Federal e emendas parlamentares em `pandas`, a partir de **fontes públicas**:

* **SIOP Dados Abertos** (SOF/MPO) — endpoint SPARQL do RDF da LOA (2001–2026, com execução:
  PLOA, LOA, lei + créditos, empenhado, liquidado, pago) e CSVs oficiais (cadastro de ações,
  créditos, acompanhamento físico, regionalização). Sem credencial.
* **Portal da Transparência** (CGU) — API REST de emendas parlamentares (autor, número,
  valores por emenda) e documentos de despesa (empenhos, pagamentos, favorecidos).
  Requer chave gratuita: <https://portaldatransparencia.gov.br/api-de-dados/cadastrar-email>.

Pacote irmão em R: [`siopr`](https://github.com/StrategicProjects/siop/tree/main/siopr).
Documentação: <https://strategicprojects.github.io/siop/siopy/> (site do monorepo:
<https://strategicprojects.github.io/siop/>).

## Instalação

```bash
pip install siopy-br         # o import continua: import siopy
pip install -e ".[dev]"      # desenvolvimento, a partir deste diretório
```

> No PyPI o pacote se chama **`siopy-br`** (o nome `siopy` é recusado por
> colidir com o projeto `slopy` na normalização do PyPI, que trata i≡l);
> o pacote importável segue sendo `siopy`, espelho do `siopr`.

## Uso

```python
import siopy

# Emendas na LOA 2025 (RP 6 = individuais, 7 = bancada, 8 = comissão, 9 = relator)
em = siopy.siop_emendas(2025, tipo=["individual", "bancada"])
em.groupby("tipo_emenda")[["loa", "empenhado", "pago"]].sum()

# Só o Ministério da Saúde, função 10
siopy.siop_emendas(2025, tipo="individual", orgao="36000", funcao="10")

# Orçamento inteiro de um órgão (qualquer RP)
siopy.siop_orcamento(2025, orgao="26000")

# Quando foi a última carga do RDF?
siopy.siop_ultima_atualizacao()

# SPARQL cru (CSV por padrão; o Virtuoso limita ORDER BY+OFFSET a 10k linhas)
siopy.siop_sparql("PREFIX loa: <http://vocab.e.gov.br/2013/09/loa#> SELECT ... ")

# CSVs oficiais (cache em disco; refresh=True para baixar de novo)
siopy.siop_cadastro_acoes(2025, "localizadores")
siopy.siop_creditos(2025)
siopy.siop_catalogo()  # tudo que está publicado na página de Dados Abertos

# Portal da Transparência — export PORTAL_TRANSPARENCIA_API_KEY=...
# As funções pt_* aceitam listas e devolvem um único DataFrame: dos autores
# (acentos normalizados sozinhos) aos documentos SIAFI de cada emenda.
deputados = siopy.camara_deputados(uf="PE")
emendas = siopy.pt_emendas(2025, autor=list(deputados["nome"]))
docs = siopy.pt_emenda_documentos(list(emendas["codigo_emenda"]))
pagamentos = siopy.pt_despesa_documento(
    docs.loc[docs["fase"] == "Pagamento", "codigo_documento"].unique()
)

# Tudo junto: 1 linha por documento, com favorecido/UG/UO
siopy.emendas_execucao(2025, autor="NOME DO PARLAMENTAR")
```

Colunas em `snake_case`, códigos como texto (zeros à esquerda preservados), valores em R$ como
`float`. O RDF do SIOP **não** traz autor nem número de emenda — isso vem do Portal da
Transparência:

<p align="center"><img src="https://raw.githubusercontent.com/StrategicProjects/siop/main/siopr/man/figures/fluxo-emendas.svg" width="90%" alt="Como as duas fontes se completam"/></p>

## Arquitetura

<p align="center"><img src="https://raw.githubusercontent.com/StrategicProjects/siop/main/siopr/man/figures/architecture.svg" width="90%" alt="Arquitetura de siopr/siopy"/></p>

## Atualização das fontes

| Fonte | Periodicidade | Como verificar |
|---|---|---|
| RDF/SPARQL SIOP | recarga a cada poucos dias (exercício corrente) e reprocessamento periódico dos anteriores | `siop_ultima_atualizacao()` |
| CSVs SIOP | publicações pontuais (data no nome do arquivo) | `siop_catalogo()` |
| PT – Tesouro Gerencial (emendas, despesas) | diária | página *Origem dos Dados* do portal |
| PT – Apoios/Solicitações (SLCN) | semanal | idem |

## Testes

```bash
pytest                 # offline, com fixtures
SIOPY_LIVE=true pytest # inclui chamadas reais (precisa de rede e da chave para pt_*)
```

## Licença

MIT. Dados: SIOP/SOF (CC BY-NC 4.0 para a documentação; dados abertos) e Portal da
Transparência (Decreto 8.777/2016).
