Skip to main content

Overview

Python Library to genereate NFS-E Paulistana

Biblioteca Python para ler e gerar NFSe’s / XML para o webservice da prefeitura de São Paulo:

A bibliotca permite de:

  • Gerar os XMLs dos documentos fiscais;

  • Validar os dados com as mesmas validações dos XSD’s ao montar os objetos, o que evita detectar os erros apenas ao transmitir o XML;

  • Importar XMLs e transforma-los em objetos Python. Usando um sistema de sub-classes, fica fácil mapear esses objetos em outros objetos ou adicionar qualquer método customizado;

A biblioteca é:

  • Simples e confiável. O código é gerado pelo generateDS a partir dos XSD’s do paulistana. Ele reflete exatamente a especificação fiscal da versão do esquema escolhida sem que você deva se perguntar qual é o grau de aderência do código;

  • Compatível com Python 3 (e com Python 2 se botar patches no generateDS e usar uma versao anterior);

  • Capaz de carregar várias versões dos esquemas. Isso pode ser bem útil ao receber um documento fiscal com um leiaute antigo.

Além disso, usando outros recursos do GenerateDS, é possível ir além dessa biblioteca e gerar automaticamente o modelo de dados do ERP.

Pelo menos no ERP Odoo que tem um framework bastante poderoso. Sendo assim, é possivel montar dinamicamente as telas do usuário, a geração do XML ou a importação do XML quase que sem escrever código (apenas relacionar os campos mapeados com os campos já existentes do ERP).

Fica então bem mais razoável para manter quando tem que atualizar os esquemas e assim também fica finalmente possível manter os dados do SPED dentro do ERP com um custo de manutenção compatível com o modelo open source.

Você pode aprender mais sobre o generateDS aqui e sobre o conjunto de tecnologias que estamos utilizando para facilitar o desenvolvimento de ERPs no Brasil: https://erpbrasil.github.io/docs/

Instalação

pip install nfselib.paulistana

You can also install the in-development version with:

pip install https://github.com/erpbrasil/nfselib.paulistana/archive/master_gen.zip

Branchs

  • master - Script de geração e outros arquivos importantes (Customizações, Testes e Readme);

  • master_gen - Versão final da bibliotaca para uso;

Documentação

https://erpbrasil.github.io/

Créditos

Esta é uma biblioteca criada atravês do esforço de das empresas:

Licença

  • Free software: MIT license

Desenvolvimento

To run all the tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows

set PYTEST_ADDOPTS=--cov-append
tox

Other

PYTEST_ADDOPTS=--cov-append tox

Authors

Changelog

0.5.0 (2026-11-15)

  • Atualiza o schema TiposNFe_v02.xsd para o pacote schemas-reformatributaria-v02-7 (24/10/2026) da Prefeitura de São Paulo e regenera os bindings v03 a partir dele. Corresponde à “Adequação à NT 9” do Manual de Utilização do Web Service de NFS-e v3.4 (Outubro/2026): acréscimo dos grupos gEstornoCred, vAjusteBC, comExt, gPgtoVinc e dos campos indDoacao/cPaisResult, que no XSD aparecem como os novos tipos tpComExt, tpDocAjusteBC/tpAjusteBC, tpGEstornoCred, tpGPgtoVinc, tpMeioPgto, tpMdic, tpNDUE, tpNDUIMP, tpFornecedor, tpCNPJBase, tpVincPrest, tpIdTransacao, entre outros. Os demais XSDs do pacote não mudaram de conteúdo.

  • CI passa a testar Python 3.10 a 3.13 (sai o 3.9).

  • Publicação automática: quando a versão do setup.py que chega ao master_gen ainda não está no PyPI, o workflow publish.yml roda os testes, publica e cria a tag e o release no GitHub com as notas desta seção do changelog. Versão sem seção no changelog não é publicada.

0.4.2 (2026-10-20)

  • Corrige regressão da 0.4.0 no pacote v02: os pedidos (PedidoEnvioLoteRPS, PedidoConsultaLote, PedidoConsultaNFe, PedidoCancelamentoNFe) voltam a sair com o namespace http://www.prefeitura.sp.gov.br/nfe no elemento raiz, como na 0.3.0. A importação de generatedsnamespaces tinha voltado a ser absoluta e falhava em silêncio.

0.4.1 (2026-10-20)

  • Corrige regressão da 0.4.0 no pacote v02: tpRPS.Assinatura (PedidoEnvioLoteRPS) e DetalheType.AssinaturaCancelamento (PedidoCancelamentoNFe) voltam a ser escritos como texto já em base64, como na 0.3.0. Na 0.4.0 a emissão e o cancelamento pelo erpbrasil.edoc falhavam com TypeError em base64.b64encode.

0.4.0 (2026-10-19)

  • Schemas sincronizados com os pacotes oficiais da prefeitura: schemas-v01-2 (13/05/2026) e schemas-reformatributaria-v02-5 (11/05/2026), conforme o manual do web service v3.3.9. Os XSDs que estavam no repositório tinham divergências (por exemplo limite de 50 RPS por lote, valores do Simples Nacional ausentes, campos de carga tributária).

  • tpRetencaoPisCofins passa a ter o domínio oficial (0 e 3 a 9, PIS/COFINS/CSLL) nos pacotes v02 e v03. O elemento RetencaoPisCofins de tpRPS é um valor simples desse tipo (a classe-grupo RetencaoPisCofins com valores 1, 2 e 3 não existe nos layouts oficiais e foi removida; ela nunca esteve numa versão publicada).

  • tpReeRepRes (v02): valores 1, 2, 3, 4 e 99, sem zeros à esquerda.

  • Novos módulos do v03: serviço assíncrono (PedidoEnvioLoteRPSAsync_v02, RetornoEnvioLoteRPSAsync_v02, ConsultaSituacaoLoteAsync_v02) e guias (EmissaoGuiaAsync_v02, ConsultaSituacaoGuiaAsync_v02, ConsultaGuia_v02).

  • Os módulos do pacote nfselib.paulistana.v03 passam a se chamar <Nome>_v02 (por exemplo PedidoCancelamentoNFe_v02). Os nomes anteriores (PedidoCancelamentoNFe e demais) continuam importáveis como módulos de compatibilidade.

  • Dependências de runtime declaradas (lxml e six), CI no GitHub Actions e publicação no PyPI por Trusted Publishing.

0.3.0 (2026-01-11)

  • Corrige o nome do pacote distribuído para nfselib_paulistana, necessário para o upload no PyPI.

0.2.0 (2026-01-11)

  • Adiciona o pacote nfselib.paulistana.v03, com as classes geradas a partir dos XSDs da Reforma Tributária (NT-007), schemas na versão 3.3.4.

0.1.0 (2020-11-08)

  • First release on PyPI.

Metadata

Release files for nfselib-paulistana 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nfselib-paulistana 0.5.0
File Size Uploaded Provenance Actions
nfselib_paulistana-0.5.0.tar.gz 1.9 MB With provenance Details for nfselib_paulistana-0.5.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for nfselib-paulistana 0.5.0
File Interpreter ABI Platform Actions
nfselib_paulistana-0.5.0-py2.py3-none-any.whl Python 2, Python 3 none any Details for nfselib_paulistana-0.5.0-py2.py3-none-any.whl

Total release size: 3.8 MB

Release files / nfselib_paulistana-0.5.0.tar.gz

Download URL nfselib_paulistana-0.5.0.tar.gz
Size 1.9 MB
Tags Source
SHA-256 checksum
How to use checksums
5e71e277b8835e451bf5c88b328380321126a47599a0a823f34840e53c61ce43
BLAKE2b-256 checksum
How to use checksums
95e2cd1aea046e2472cf84a2a60b338f3f4a97a8bc4bb01857f5dfbb65bd3b63
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 15, 2026.

Transparency log

Release files / nfselib_paulistana-0.5.0-py2.py3-none-any.whl

Download URL nfselib_paulistana-0.5.0-py2.py3-none-any.whl
Size 1.9 MB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
3fd9f7e20d6819da8cdd36b0752f175b1090c41527bb52fabaf489aefe58d9ca
BLAKE2b-256 checksum
How to use checksums
ccdada874cf9c5539d8d0a6e1c9d99548ef0f3c76493f29dcc02684e9b819c49
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 15, 2026.

Transparency log

Security for nfselib-paulistana 0.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for nfselib_paulistana-0.5.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 15, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page