# AlegraPy
Este paquete nos permite consumir el API del la plataforma de facturacion Alegra mediante python 🐍
## Características
- Permite leer facturas, pagos, productos, contactos
- Permite crear facturas, pagos, productos, contactos
- Permite borrar facturas, pagos, productos, contactos
## Instalación y uso
### 1. Obtener token de acceso
Debes seguir los siguientes pasos para obtener el token de acceso:
- Ingresar a la aplicación de [Alegra](https://www.alegra.com/).
- Haz clic sobre el vínculo "Configuración" en la parte superior derecha de la pantalla de Alegra y haz clic en la sección "API - Integraciones con otros sistemas"
- En la nueva pantalla puedes encontrar el correo con el cual debes acceder al API y el token. Si aún no cuentas con un token puedes generarlo también.
### 2. Instalación
```
pip install alegrapy==0.0.1
```
### 3. Uso
Un ejemplo para usar este paquete
```py
from alegra import invoices, contacts, session
session.user = "your_email@domnain.com"
session.token = "your_token"
invoice = invoices()
invoice.read(1,fields='pdf')
invoice.list(0,3)
contact = contacts()
contact.read(12)
contact.list(0,2)
```
## Créditos
- Camilo Andrés Rodriguez
## referencias
- https://developer.alegra.com/
## Licencia
Este proyecto está bajo la Licencia [MIT].
---
¡Puedes personalizarlo según las necesidades específicas de tu proyecto!
Raw data
{
"_id": null,
"home_page": "https://github.com/andresroh/alegrapy_pkg",
"name": "alegrapy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,alegra,alegra.com",
"author": "Camilo Andr\u00e9s Rodr\u00edguez",
"author_email": "andres.roh@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f7/d0/b2de5204ae0e80d73258d57646ff4871deb1cbf3c7f5dd4bb57561fcdafe/alegrapy-0.0.2.tar.gz",
"platform": null,
"description": "# AlegraPy\n\nEste paquete nos permite consumir el API del la plataforma de facturacion Alegra mediante python \ud83d\udc0d\n\n## Caracter\u00edsticas\n\n- Permite leer facturas, pagos, productos, contactos\n- Permite crear facturas, pagos, productos, contactos\n- Permite borrar facturas, pagos, productos, contactos\n\n## Instalaci\u00f3n y uso\n\n### 1. Obtener token de acceso\nDebes seguir los siguientes pasos para obtener el token de acceso:\n\n- Ingresar a la aplicaci\u00f3n de [Alegra](https://www.alegra.com/).\n- Haz clic sobre el v\u00ednculo \"Configuraci\u00f3n\" en la parte superior derecha de la pantalla de Alegra y haz clic en la secci\u00f3n \"API - Integraciones con otros sistemas\"\n- En la nueva pantalla puedes encontrar el correo con el cual debes acceder al API y el token. Si a\u00fan no cuentas con un token puedes generarlo tambi\u00e9n.\n\n### 2. Instalaci\u00f3n\n\n```\npip install alegrapy==0.0.1\n```\n\n### 3. Uso\n\nUn ejemplo para usar este paquete\n\n```py\nfrom alegra import invoices, contacts, session\n\nsession.user = \"your_email@domnain.com\"\nsession.token = \"your_token\"\n\ninvoice = invoices()\ninvoice.read(1,fields='pdf')\ninvoice.list(0,3)\n\ncontact = contacts()\ncontact.read(12)\ncontact.list(0,2)\n```\n\n## Cr\u00e9ditos\n\n- Camilo Andr\u00e9s Rodriguez\n\n## referencias\n\n- https://developer.alegra.com/\n\n\n## Licencia\n\nEste proyecto est\u00e1 bajo la Licencia [MIT].\n\n---\n\n\u00a1Puedes personalizarlo seg\u00fan las necesidades espec\u00edficas de tu proyecto!\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "alegra-api-client: Python package for consuming the Alegra API",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/andresroh/alegrapy_pkg"
},
"split_keywords": [
"python",
"alegra",
"alegra.com"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f7d0b2de5204ae0e80d73258d57646ff4871deb1cbf3c7f5dd4bb57561fcdafe",
"md5": "ed8875bf82eae4e0fd5cf00bf033741a",
"sha256": "dda63d9acb98f08823454e7c285d40cd6fba1e76e5fa9a7ab6216b34e389022d"
},
"downloads": -1,
"filename": "alegrapy-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "ed8875bf82eae4e0fd5cf00bf033741a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4316,
"upload_time": "2023-06-07T15:47:59",
"upload_time_iso_8601": "2023-06-07T15:47:59.595157Z",
"url": "https://files.pythonhosted.org/packages/f7/d0/b2de5204ae0e80d73258d57646ff4871deb1cbf3c7f5dd4bb57561fcdafe/alegrapy-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-07 15:47:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "andresroh",
"github_project": "alegrapy_pkg",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "alegrapy"
}
JSON
