satcfe 2.0

Abstração do acesso ao equipamento SAT (SAT-CF-e)

---

This project is about SAT-CF-e, a system for autorization and transmission for fiscal documents, developed by the Secretariat of Finance from state of São Paulo, Brazil. The entire project, variables, methods and class names, as well as documentation, are written in brazilian portuguese.

Refer to the oficial web site for more information (in brazilian portuguese only).

---

---

Este projeto refere-se à tecnologia SAT-CF-e desenvolvida pela Secretaria da Fazenda do Estado de São Paulo e faz parte de um grupo de cinco projetos que resolvem problemas específicos, mas relacionados.

Especificamente, este projeto é uma abstração para acesso às funções da biblioteca SAT que é fornecida pelos fabricantes dos equipamentos. Para maiores informações, consulte a documentação do projeto.

Se estiver procurando meios para emitir um extrato do CF-e-SAT, o Projeto SATExtrato pode ajudar.

Exemplo de Uso

Este é um exemplo básico de uso, sobre como consultar o equipamento SAT conectado e configurado no computador local:

>>> from satcfe import BibliotecaSAT
>>> from satcfe import ClienteSATLocal
>>> cliente = ClienteSATLocal(
...         BibliotecaSAT('/caminho/para/libsat.so'),  # ou DLL no Windows
...         codigo_ativacao='12345678')
...
>>> resposta = cliente.consultar_sat()
>>> print(resposta.mensagem)
'SAT em Operação'

Para conectar e configurar o equipamento SAT você deverá seguir as orientações do fabricante. Normalmente utiliza-se um equipamento SAT fabricado especificamente para desenvolvimento. Para aprender mais sobre a utilização desta biblioteca, consulte a documentação. Se precisar de ajuda, você pode recorrer à sala de chat do projeto no Gitter.

Execução dos Testes

Este é um tópico voltado para aquelas pessoas interessadas no desenvolvimento deste projeto em si ou para aqueles que queiram experimentar algum setup alternativo, como outras versões de Python ou das dependências do projeto.

Para facilitar a execução dos testes e não correr riscos de executar certos comandos em um equipamento real (mesmo que seja um equipamento para desenvolvimento), os testes podem ser executados contra uma biblioteca de simulação, chamada de mockuplib, que acompanha o projeto.

Portanto, a maneira mais prática é usando Pipenv com tox, contra a biblioteca de simulação. Primeiro compile a biblioteca de simulação (você irá precisar das ferramentas GNU Make e GNU GCC) e então execute tox via Pipenv:

$ git clone [e-mail]:base4sistemas/satcfe.git
$ cd satcfe
$ make mockuplib
$ pipenv install --dev --clear
$ pipenv run tox

Dê uma olhada no arquivo tox.ini e procure pela propriedade envlist, que relaciona as versões de Python que serão usadas nos testes. Se você quiser executar os testes contra uma versão específica de Python, utilize a opção -e. Por exemplo, para executar os testes com a versão 3.6 de Python:

$ pipenv run tox -e py36

Existem muitas outras configurações e opções avançadas de testes para desenvolvimento desta biblioteca, caso esteja interessado neste tópico, na documentação do projeto.