Skip to content

Latest commit

 

History

History
95 lines (66 loc) · 3.32 KB

README.es-MX.md

File metadata and controls

95 lines (66 loc) · 3.32 KB

Facturapi Logo

FacturAPI – Librería de Python

test codecov PyPI version Code style: black

Esta es una librería de Python para https://www.facturapi.io

⚠️Advertencia: Esta librería NO es oficial y aún sigue en desarrollo. No es un producto final.⚠️

FacturAPI facilita la creación de facturas válidas para desarrolladores en México (Facturas Electrónicas o CFDI).

Esta librería está basada en cuenca-python 💙.

💻 Instalación

Fácil, únicamente utiliza pip para instalar la librería:

pip install facturapi

🚀 Primeros pasos

Autenticación con API Key

Asegurate de crear una cuenta gratis en FacturAPI y tener acceso a tus llaves de test y live.

Hay dos formas de configurar tus llaves para usar la librería:

  1. Variable de entorno: Configura una variable de entorno y la librería usará la llave automáticamente:

    export FACTURAPI_KEY=TU_API_KEY
  2. Usando el método configure: Puedes configurar tu llave en el código usando el método configure:

    from facturapi import configure
    
    configure(api_key='TU_API_KEY')

Crea un Cliente

Después de configurar tu llave, puedes usar la librería para realizar varias acciones en los recursos de FacturAPI, por ejempo crear un Cliente:

import facturapi
from facturapi.resources.customers import CustomerRequest, CustomerUpdateRequest

customer = facturapi.Customer.create(data=CustomerRequest(
    legal_name='Frida Kahlo',
    tax_id='ABCD111111CBA',
    email='[email protected]',
))

Para más detalles en los datos necesarios para crear un Cliente y otros recursos, revisa la documentación.

Puedes encontrar más ejemplos de código de cómo crear y usar recursos en el directorio de examples.

📚 Documentación

Encuentra más información de Facturapi y sus recursos en sus docs.

O para más detalles técnicos y de la librería, entra a la documentación de facturapi-python.

💡 Contribuye

¿Encontraste un bug?

Crea un issue explicando el problema y cómo replicarlo.

¿Quieres contribuir?

Haz un fork del respositorio y crea tu PR, ¡toda la ayuda es bienvenida y apreciada! No olvides mantener la cobertura del código arriba de 98%, nos encanta tener código testeado. 😋

Contactos:


Desarrollado y mantenido con 💙 por Cuenca

Cuenca Logo