PyNFe 项目教程

PyNFe 项目教程

PyNFe Projeto de biblioteca para fazer interface com o webservice de Nota Fiscal eletrônica para Python, disponível sob LGPL. 项目地址: https://gitcode.com/gh_mirrors/py/PyNFe

1. 项目的目录结构及介绍

PyNFe 项目的目录结构如下：

PyNFe/
├── AUTHORS
├── LICENSE
├── MANIFEST.in
├── PLANEJAMENTO
├── README.md
├── pyproject.toml
├── requirements-nfse.txt
├── requirements.txt
├── separarpfx.sh
├── setup.py
├── pynfe/
│   ├── __init__.py
│   ├── ...
├── tests/
│   ├── __init__.py
│   ├── ...
└── github/
    └── workflows/
        └── ...

目录结构介绍

• AUTHORS: 项目作者列表。
• LICENSE: 项目许可证文件，本项目使用 LGPL-3.0 许可证。
• MANIFEST.in: 用于指定在打包时需要包含的文件。
• PLANEJAMENTO: 项目计划文档。
• README.md: 项目介绍和使用说明。
• pyproject.toml: 项目配置文件，用于定义项目依赖和构建工具。
• requirements-nfse.txt: NFS-e 模块的依赖文件。
• requirements.txt: 项目的主要依赖文件。
• separarpfx.sh: 用于处理证书的脚本。
• setup.py: 项目的安装脚本。
• pynfe/: 项目的主要代码目录，包含与 NF-e、NFC-e、NFS-e 和 MDF-e 相关的接口实现。
• tests/: 项目的测试代码目录。
• github/workflows/: GitHub Actions 的工作流配置文件。

2. 项目的启动文件介绍

PyNFe 项目没有明确的“启动文件”，因为它是一个库，而不是一个独立的应用程序。然而，你可以通过导入 pynfe 模块来使用其功能。例如：

from pynfe.processamento.comunicacao import ComunicacaoSefaz

certificado = "/home/user/certificado.pfx"
senha = 'senha'
uf = 'pr'
homologacao = True

con = ComunicacaoSefaz(uf, certificado, senha, homologacao)
xml = con.status_servico('nfe')
print(xml.text)

3. 项目的配置文件介绍

pyproject.toml

pyproject.toml 是 Python 项目的配置文件，用于定义项目的构建系统和依赖项。以下是 PyNFe 项目中的 pyproject.toml 文件示例：

[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "pynfe"
version = "0.1.0"
description = "Projeto de biblioteca para fazer interface com o webservice de Nota Fiscal eletrônica para Python"
authors = [
    { name="TadaSoftware", email="contact@tadasoftware.com" }
]
dependencies = [
    "lxml",
    "signxml",
    "pyopenssl",
    "requests",
    "suds-jurko",
    "pyxb"
]

requirements.txt

requirements.txt 文件列出了项目的主要依赖项，用于在安装项目时自动安装这些依赖项。以下是 PyNFe 项目中的 requirements.txt 文件示例：

lxml
signxml
pyopenssl
requests
suds-jurko
pyxb

requirements-nfse.txt

requirements-nfse.txt 文件列出了 NFS-e 模块的额外依赖项。以下是 PyNFe 项目中的 requirements-nfse.txt 文件示例：

suds-jurko
pyxb

通过这些配置文件，你可以轻松地管理和安装 PyNFe 项目的依赖项，并确保项目的正确构建和运行。

PyNFe Projeto de biblioteca para fazer interface com o webservice de Nota Fiscal eletrônica para Python, disponível sob LGPL. 项目地址: https://gitcode.com/gh_mirrors/py/PyNFe