Instalação no Windows e no Linux
Instale o projeto acbr-python com pip e importe acbr em Python. A versão publicada documentada é 0.1.0a5, alpha. Ela não exige Node.js, npm, PHP ou um framework Python.
Pré-requisitos
| Item | Requisito |
|---|---|
| Python | CPython 3.11, 3.12, 3.13 ou 3.14 em 64 bits |
| Sistema | Windows x64 ou Linux x64/glibc; referência Ubuntu 24.04 |
| Instalação pelo PyPI | pip e acesso ao índice, ou um wheel obtido previamente |
| Operações nativas | Runtime ACBr 0.2.1 verificado, instalado separadamente |
| Ajuda e contrato | Funcionam sem runtime, A1 e rede após instalar o pacote |
Windows — PowerShell
Escolha uma versão instalada no intervalo suportado. O exemplo usa Python 3.13:
py -3.13 -m venv .venv
.\.venv\Scripts\python.exe -m pip install "acbr-python==0.1.0a5"
.\.venv\Scripts\python.exe -m acbr --help
.\.venv\Scripts\python.exe -m acbr describe Ide.tpNF
.\.venv\Scripts\python.exe -m acbr describe TTipoNFe --jsonUsar o executável do ambiente virtual diretamente dispensa alterar políticas de execução do PowerShell. Nos próximos comandos, python significa esse executável quando o ambiente não estiver ativado.
Linux — bash
Use uma instalação CPython x64/glibc compatível. O exemplo usa Python 3.13:
python3.13 -m venv .venv
.venv/bin/python -m pip install "acbr-python==0.1.0a5"
.venv/bin/python -m acbr --help
.venv/bin/python -m acbr describe Ide.tpNF
.venv/bin/python -m acbr describe TTipoNFe --jsonSe sua distribuição não disponibiliza esse executável, use outro CPython entre 3.11 e 3.14. O pacote venv da distribuição pode ser necessário para criar o ambiente. A compatibilidade com glibc não garante que toda distribuição execute o binário de referência; valide no sistema de destino.
Verifique a versão e a ajuda
python -m acbr --version
python -m acbr ajuda 'Det[].Prod.vProd'A saída esperada é acbr-python 0.1.0a5. A ajuda retorna JSON com revisão e hash do contrato. As consultas de Ide.tpNF e TTipoNFe mostram tnEntrada e tnSaida; o padrão declarado tnSaida pertence ao campo. Esses metadados não preenchem o documento nem escolhem sua operação fiscal. Consulte a ajuda de campos e tipos.
O CLI da a5 oferece describe, ajuda, --version, runtime install, doctor e suas opções de --help. describe usa texto em português por padrão e --json preserva o contrato de metadados. Não há comando CLI de emissão fiscal.
Instalação com artefatos obtidos previamente
Em uma máquina autorizada a acessar o PyPI, obtenha o wheel da versão fixada:
python -m pip download --only-binary=:all: --no-deps --dest wheelhouse "acbr-python==0.1.0a5"Transfira o diretório por seu processo de distribuição e registre a origem e o hash do arquivo. No ambiente de destino:
python -m pip install --no-index --find-links wheelhouse "acbr-python==0.1.0a5"O wheel não incorpora o runtime. Para operações nativas offline, obtenha também o arquivo da plataforma e siga a instalação com --archive em runtime e integridade.
Fonte fixada da versão publicada
Para obter a mesma fonte da versão publicada, o commit da tag v0.1.0a5 é:
python -m pip install "git+https://github.com/cosmemilton/acbr-python.git@dc0f2bba99278f1763329d17b4662c947894ec94"O repositório pode exigir acesso autorizado. Use o mecanismo de autenticação já aprovado; mantenha tokens fora de URLs, histórico de shell e arquivos do projeto. A instalação pela fonte exige Git e ferramentas de build; o backend declara setuptools>=77.0.3.
A tag publicada v0.1.0a5 corresponde ao commit acima. Os comandos e a API de ajuda descritos neste site fazem parte do wheel 0.1.0a5, sem exigir instalação de uma branch de desenvolvimento.
Próximo passo
Explore a ajuda offline e o contrato antes de montar o documento. Para geração, assinatura e validação locais, instale e confira o runtime nativo. Use o manifesto correspondente à versão do cliente, preservando seus arquivos e licenças.