The redocmx module is a Python client for interacting with the redoc.mx REST API to convert CFDIs (Comprobante Fiscal Digital por Internet) to PDFs.
This client simplifies the process of sending XML data and retrieving the converted PDF, along with transaction details and metadata.
This package is synchronous.
To install the module, run:
pip install redocmxFirst, import the module and create an instance of the Redoc client.
You can optionally pass your API key as an argument, or the client will attempt to load it from the REDOC_API_KEY environment variable.
from redocmx import RedocmxClient
redoc = RedocmxClient('your_api_key_here')The redocmx provides two options for loading CFDI data: from a file or directly from a string.
cfdi = redoc.cfdi.from_file('./path/to/your/file.xml')cfdi = redoc.cfdi.from_string('<xml_content_string_here>');To convert the loaded CFDI to a PDF:
try:
pdf = cfdi.to_pdf()
with open('./nomina.pdf', 'wb') as pdf_file:
pdf_file.write(pdf.to_buffer())
print(f"Transaction ID: {pdf.get_transaction_id()}")
print(f"Total Pages: {pdf.get_total_pages()}")
print(f"Total Time: {pdf.get_total_time_ms()} ms")
print(f"Metadata: {pdf.get_metadata()}")
except:
print("An error occurred during the conversion")The redoc object is an instance of Redoc, created using RedocmxClient(api_key).
| Method | Description |
|---|---|
| redoc.cfdi.from_file(file_path) | Returns: Cfdi - Instance Loads file content from the file system for converting a CFDI to PDF. The file should be valid XML for a CFDI. It returns an instance of the Cfdi class, which can be used to obtain the PDF. |
| redoc.cfdi.from_string(file_content) | Returns: Cfdi - Instance Uses a CFDI as a string for converting the CFDI to PDF. The string should be valid XML for a CFDI. It returns an instance of the Cfdi class, which can be used to obtain the PDF. |
The cfdi object is an instance of Cfdi, created using redoc.cfdi.from_file(file_path) or redoc.cfdi.from_string(file_content).
| Method | Description |
|---|---|
| cfdi.set_addenda(str) | Params: String Allows the use of a redoc addenda for full control over the design of the final PDF. |
| cfdi.to_pdf(options) | Params: Dictionary - PdfOptions Returns: Pdf - Instance An instance of the Pdf class, which, when invoked, converts the CFDI into a PDF and stores it, along with the generated data from the conversion request. |
{
"style_pdf": "John"
}The pdf object is an instance of Pdf, created from cfdi.to_pdf(options).
| Method | Description |
|---|---|
| pdf.to_buffer() | Returns: Buffer The PDF document as a buffer, ready for storage in the file system or to be sent back in an HTTP request. |
| pdf.get_transaction_id() | Returns: String - UUID A unique ID for the transaction request to the redoc service. |
| pdf.get_total_pages() | Returns: Integer The total number of pages generated for the PDF file. |
| pdf.get_total_time_ms() | Returns: Integer Time in milliseconds taken to convert the CFDI to PDF. |
| pdf.get_metadata() | Returns: Dictionary - CfdiMetadata General information from the converted CFDI. |
{
TDB...
}Contributions are welcome! Please feel free to submit a pull request or open an issue for any bugs, features, or improvements.
This project is licensed under the MIT License - see the LICENSE file for details.