Skip to content

Getting Started

Installation

Basic installation

pip install brazilfiscalreport

This installs the core library with support for DANFE and DACCe. Requires Python 3.8+.

Optional dependencies

Some document types require additional packages:

pip install 'brazilfiscalreport[dacte]'

pip install 'brazilfiscalreport[damdfe]'

pip install 'brazilfiscalreport[danfse]'

pip install 'brazilfiscalreport[cli]'

pip install 'brazilfiscalreport[dacte,damdfe,danfse,cli]'

Quick Start

Using Python code

Generate a DANFE PDF from an NF-e XML file in just a few lines:

from brazilfiscalreport.danfe import Danfe

# Load the XML content
with open("nfe.xml", "r", encoding="utf8") as file:
    xml_content = file.read()

# Generate the PDF
danfe = Danfe(xml=xml_content)
danfe.output("danfe.pdf")

No XML at hand?

Grab a sample from tests/fixtures or try the online demo with your own file.

The same pattern applies to all document types:

from brazilfiscalreport.danfe import Danfe

danfe = Danfe(xml=xml_content)
danfe.output("danfe.pdf")

from brazilfiscalreport.dacce import DaCCe

dacce = DaCCe(xml=xml_content)
dacce.output("dacce.pdf")

from brazilfiscalreport.dacte import Dacte

dacte = Dacte(xml=xml_content)
dacte.output("dacte.pdf")

from brazilfiscalreport.damdfe import Damdfe

damdfe = Damdfe(xml=xml_content)
damdfe.output("damdfe.pdf")

from brazilfiscalreport.danfse import Danfse

danfse = Danfse(xml=xml_content)
danfse.output("danfse.pdf")

Using the CLI

For quick generation from the terminal:

bfrep danfe /path/to/nfe.xml
bfrep dacce /path/to/cce.xml
bfrep dacte /path/to/cte.xml
bfrep damdfe /path/to/mdfe.xml
bfrep danfse /path/to/nfse.xml

See the CLI documentation for configuration options.

Next steps