Metadata-Version: 2.4
Name: seigov
Version: 0.1.1
Summary: Cliente Python para os Web Services SOAP do SEI (Sistema Eletronico de Informacoes) e do SIP
Project-URL: Homepage, https://github.com/StrategicProjects/seigov
Project-URL: Documentation, https://strategicprojects.github.io/seigov/
Project-URL: Issues, https://github.com/StrategicProjects/seigov/issues
Author-email: André Leite <leite@castlab.org>, Hugo Vasconcelos <hugo.vasconcelos@ufpe.br>, Diogo Bezerra <diogo.bezerra@ufpe.br>, Marcos Wasiliew <marcos.wasilew@gmail.com>, Carlos Amorim <carlos.agaf@ufpe.br>, Julia Nascimento Barreto <juliabarreto@gd.seplag.pe.gov.br>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Keywords: govbr,processo-eletronico,sei,sip,soap,zeep
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Office/Business
Requires-Python: >=3.9
Requires-Dist: pandas>=1.5
Requires-Dist: zeep>=4.2
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: pytest-mock>=3; extra == 'dev'
Requires-Dist: pytest>=7; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.24; extra == 'docs'
Description-Content-Type: text/markdown

# seigov <a href="https://github.com/StrategicProjects/seigov"><img src="https://raw.githubusercontent.com/StrategicProjects/seigov/main/docs/seigovHex.svg" align="right" height="130" alt="seigov logo" /></a>

[![CI](https://github.com/StrategicProjects/seigov/actions/workflows/ci.yml/badge.svg)](https://github.com/StrategicProjects/seigov/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/seigov.svg)](https://pypi.org/project/seigov/)
[![Docs](https://img.shields.io/badge/docs-mkdocs-blue.svg)](https://strategicprojects.github.io/seigov/)

📖 **Documentação:** <https://strategicprojects.github.io/seigov/>

Cliente Python para os **Web Services SOAP do SEI** (Sistema Eletrônico de
Informações) e do **SIP** (Sistema de Permissões). Construído sobre
[`zeep`](https://docs.python-zeep.org/), devolve os resultados como
`pandas.DataFrame`. É a porta Python do pacote R
[`rsei`](https://github.com/StrategicProjects/rsei).

> **⚠️ Acesso restrito por IP.** Os Web Services do SEI só respondem a
> requisições vindas de IPs/servidores previamente autorizados no cadastro do
> serviço. As funções só retornam dados a partir de um host autorizado.

> **Genérico.** O pacote não é amarrado a nenhum órgão: informe o endpoint do
> Web Service do **seu** SEI em `SeiClient(url=...)`.

## Instalação

```bash
pip install seigov            # (após publicação no PyPI)
# ou, do código-fonte:
pip install -e ".[dev]"
```

## Uso

```python
from seigov import SeiClient

sei = SeiClient(
    url="https://sei.<seu-orgao>.gov.br/sei/ws/SeiWS.php",
    sigla_sistema="MEU_SISTEMA",
    identificacao_servico="minha-chave",   # chave de acesso
)

# Consultar um processo (retorna um DataFrame)
df = sei.consultar_procedimento("12.1.000000077-4")

# Vários de uma vez (empilha; coluna 'erro' isola falhas por linha)
lote = sei.consultar_procedimentos(["12.1.000000077-4", "12.1.000000078-2"])

# Listagens
unidades = sei.listar_unidades()
series   = sei.listar_series()
```

Configuração também por variáveis de ambiente: `SEIGOV_URL`,
`SEIGOV_SIGLA_SISTEMA`, `SEIGOV_IDENTIFICACAO_SERVICO`, `SEIGOV_ID_UNIDADE`.

SIP (permissões):

```python
from seigov import SipClient
sip = SipClient(url="https://sei.<seu-orgao>.gov.br/sip/controlador_ws.php?servico=sip",
                chave_acesso="...", id_sistema="...")
perms = sip.listar_permissao(id_unidade="110000001")
```

## Estado

Em desenvolvimento (Fase 0/1: core + consultas/listagens iniciais). Veja
`PLAN.md` para o roteiro completo (escrita, SIP, helpers em lote/por-processo).

## Licença

GPL-3.0-or-later.
