Skip to main content

Cliente Python para API pública do DataJud

Project description

pydatajud

Cliente Python para consultar a API pública do DataJud/CNJ por número CNJ e extrair movimentações processuais em formato estruturado.

O projeto não é afiliado ao CNJ. Ele apenas empacota um fluxo comum de consulta à API pública oficial.

Instalação

pip install pydatajud

Para desenvolvimento local:

pip install -e ".[dev]"

Uso rápido

from pydatajud import DataJudClient

client = DataJudClient(api_key="sua-api-key")
result = client.search_by_process_number("0000832-35.2018.4.01.3202")

print(result.endpoint)
print(result.movimentos)

API key pública do DataJud

A API pública do DataJud usa uma chave pública no cabeçalho Authorization: APIKey ....

Até o momento, o CNJ publica uma chave pública única e vigente na página oficial de acesso da wiki do DataJud. Para usar a biblioteca, copie a chave atual de:

https://datajud-wiki.cnj.jus.br/api-publica/acesso/

Depois defina:

export DATAJUD_API_KEY="cole-a-chave-publica-vigente-aqui"

O próprio CNJ informa que essa chave pode ser alterada a qualquer momento. Por isso, a documentação do pydatajud aponta para a página oficial em vez de tratar uma chave copiada em README como permanente.

CLI

export DATAJUD_API_KEY="sua-api-key"
pydatajud --processo "0000832-35.2018.4.01.3202"

Também é possível passar a chave diretamente:

pydatajud --api-key "sua-api-key" --processo "0000832-35.2018.4.01.3202"

Para imprimir apenas a lista de movimentações:

pydatajud --processo "0000832-35.2018.4.01.3202" --movimentos-only

O que a biblioteca faz

  • Valida e normaliza números processuais CNJ.
  • Resolve automaticamente o endpoint DataJud a partir dos campos J e TR.
  • Consulta o endpoint público correspondente.
  • Retorna os hits brutos e a lista agregada de movimentos.
  • Expõe erros próprios para autenticação, resposta inválida, processo não encontrado e tribunal sem endpoint mapeado.

Para entender a lógica de resolução de endpoints a partir da estrutura do número CNJ, leia docs/datajud-resolver.md.

Limitações

  • A API pública do DataJud exige chave APIKey.
  • Processos sigilosos ou indisponíveis na base pública podem não retornar dados.
  • A cobertura, disponibilidade e regras de uso são definidas pelo CNJ.
  • O usuário é responsável por cumprir os termos de uso do CNJ e a legislação aplicável, incluindo LGPD.

Desenvolvimento

python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
ruff check .
ruff format --check .
mypy src tests
pytest
python -m build
twine check dist/*

Links úteis

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pydatajud-0.1.1.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pydatajud-0.1.1-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file pydatajud-0.1.1.tar.gz.

File metadata

  • Download URL: pydatajud-0.1.1.tar.gz
  • Upload date:
  • Size: 11.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pydatajud-0.1.1.tar.gz
Algorithm Hash digest
SHA256 6de84bff15a68fcb245e891da104b0e3fa2e9c4ec4fb6f139e11c70695ada5d1
MD5 2c6cc3795b355342c0eba6511693d953
BLAKE2b-256 eb7dc5246eb509ed98f79aa3c60d3cb9191a52b1f27f429db905661eb54d1718

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydatajud-0.1.1.tar.gz:

Publisher: publish.yml on Filipe-Araujo0/pydatajud

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pydatajud-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: pydatajud-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pydatajud-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8a6dae902ed8a7f5959b3775a0ee3c392ff6833b0918fd58641e9bf3b2a95716
MD5 97253f58f50b983d79fb53a2df4228e0
BLAKE2b-256 18a9379b031ca2d8bf4a392671ba12f707086b9d1fb28ae85c342852ca5225e5

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydatajud-0.1.1-py3-none-any.whl:

Publisher: publish.yml on Filipe-Araujo0/pydatajud

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page