| Name | alanube JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | None |
| Summary | Python library to connect with Alanube API |
| upload_time | 2025-01-30 04:48:28 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2025 Wilmer Martinez Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
alanube
api
dgii
ncf
ncf-e
electronic billing
electronic bill
billing
bill
invoice
facturación electrónica
factura
factura electrónica
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
requests
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Alanube Python API
Python library to connect with Alanube API
## Instalation
To install the Alanube library, you can use pip:
```sh
pip install alanube
```
## Usage
```py
# Import the Alanube class specific to the country,
# in this case from `alanube.do` for the Dominican Republic
from alanube.do import Alanube
# Connect to the API
Alanube.connect("[TOKEN]")
payload = {...}
data = Alanube.send_document(encf_type=31, payload)
```
Now you can easily and efficiently use the Alanube API with this Python library!
## Contents
- `do`: Implementation for the Dominican Republic (DGII). This is the only fully developed directory and contains all the necessary structure and logic to work with the Alanube API for this country.
- `pa`: Implementation for Panama (future). If you need to develop for Panama, create a directory named `pa` at the same level as `do` within `alanube` and replicate the internal structure of `do`.
- `cr`: Implementation for Costa Rica (future). Similarly, create a `cr` directory following the same structure as `do`.
- `bo`: Implementation for Bolivia (future). The `bo` directory should also follow the structure of `do`.
For the missing countries, you can use the `do` directory as a reference to build the required implementations, adapting the logic to meet the specific local requirements of each country.
### Links
* [Alanube Official Website](https://www.alanube.co/)
* [Alanube Documentation](https://developer.alanube.co/)
## Developers
If you're contributing to the development of this library, here are the steps to set up your environment and run the tests:
### Setting Up the Environment
1. Clone the repository:
```sh
git clone https://github.com/wilmerm/alanube-python-api.git
cd alanube-python-api
```
2. Create a virtual environment (optional but recommended):
```sh
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
```
3. Install the required dependencies:
```sh
pip install -r requirements.txt
pip install -r requirements-dev.txt
```
4. Install the library in editable mode:
```sh
pip install -e .
```
5. **Code Style**. We follow PEP 8 for coding standards. Please ensure your code is formatted accordingly before submitting a pull request.
```sh
flake8 alanube
```
### Running the Tests
1. Navigate to the project root directory.
2. Execute the tests with unittest:
```sh
python -m unittest discover -s alanube/tests -p "*.py"
```
* -s: Specifies the directory to look for tests (tests folder).
* -p: Defines the pattern for test file names (e.g., *.py).
### Building and Publishing the Library
To compile and upload the library to PyPI, follow these steps:
1. Ensure you have the necessary dependencies:
```sh
pip install build twine
```
2. Build the package:
```sh
python -m build
```
3. (Optional) Verify the package:
```sh
twine check dist/*
```
4. Upload the package to PyPI:
```sh
python -m twine upload dist/*
```
## Licence
This project is licensed under the MIT License.
## Proyect Status
This project is under development
## Contribution 💗
If you find value in this project and would like to show your support, please consider making a donation via PayPal:
[Donate on PayPal](https://paypal.me/martinezwilmer?country.x=DO&locale.x=es_XC)
Your generosity helps us to continue improving and maintaining this project. We appreciate every contribution, however small. Thanks for being part of our community!
Raw data
{
"_id": null,
"home_page": null,
"name": "alanube",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "alanube, api, dgii, ncf, ncf-e, electronic billing, electronic bill, billing, bill, invoice, facturaci\u00f3n electr\u00f3nica, factura, factura electr\u00f3nica",
"author": null,
"author_email": "Wilmer Martinez <info@wilmermartinez.dev>",
"download_url": "https://files.pythonhosted.org/packages/91/36/25e2fbcf688949664ff5d32e0ba085135621f30728ef39a87cbdf3753b6e/alanube-0.4.0.tar.gz",
"platform": null,
"description": "# Alanube Python API\n\nPython library to connect with Alanube API\n\n## Instalation\n\nTo install the Alanube library, you can use pip:\n\n```sh\npip install alanube\n```\n\n## Usage\n\n```py\n# Import the Alanube class specific to the country,\n# in this case from `alanube.do` for the Dominican Republic\nfrom alanube.do import Alanube\n\n# Connect to the API\nAlanube.connect(\"[TOKEN]\")\n\npayload = {...}\n\ndata = Alanube.send_document(encf_type=31, payload)\n```\n\nNow you can easily and efficiently use the Alanube API with this Python library!\n\n## Contents\n\n- `do`: Implementation for the Dominican Republic (DGII). This is the only fully developed directory and contains all the necessary structure and logic to work with the Alanube API for this country.\n- `pa`: Implementation for Panama (future). If you need to develop for Panama, create a directory named `pa` at the same level as `do` within `alanube` and replicate the internal structure of `do`.\n- `cr`: Implementation for Costa Rica (future). Similarly, create a `cr` directory following the same structure as `do`.\n- `bo`: Implementation for Bolivia (future). The `bo` directory should also follow the structure of `do`.\n\nFor the missing countries, you can use the `do` directory as a reference to build the required implementations, adapting the logic to meet the specific local requirements of each country.\n\n### Links\n* [Alanube Official Website](https://www.alanube.co/)\n* [Alanube Documentation](https://developer.alanube.co/)\n\n## Developers\n\nIf you're contributing to the development of this library, here are the steps to set up your environment and run the tests:\n\n### Setting Up the Environment\n\n1. Clone the repository:\n\n ```sh\n git clone https://github.com/wilmerm/alanube-python-api.git\n cd alanube-python-api\n ```\n\n2. Create a virtual environment (optional but recommended):\n\n ```sh\n python -m venv venv\n source venv/bin/activate # On Windows: venv\\Scripts\\activate\n ```\n\n3. Install the required dependencies:\n\n ```sh\n pip install -r requirements.txt\n pip install -r requirements-dev.txt\n ```\n\n4. Install the library in editable mode:\n\n ```sh\n pip install -e .\n ```\n\n5. **Code Style**. We follow PEP 8 for coding standards. Please ensure your code is formatted accordingly before submitting a pull request.\n\n ```sh\n flake8 alanube\n ```\n\n### Running the Tests\n\n1. Navigate to the project root directory.\n\n2. Execute the tests with unittest:\n\n ```sh\n python -m unittest discover -s alanube/tests -p \"*.py\"\n ```\n\n * -s: Specifies the directory to look for tests (tests folder).\n * -p: Defines the pattern for test file names (e.g., *.py).\n\n### Building and Publishing the Library\n\nTo compile and upload the library to PyPI, follow these steps:\n\n1. Ensure you have the necessary dependencies:\n\n ```sh\n pip install build twine\n ```\n\n2. Build the package:\n\n ```sh\n python -m build\n ```\n\n3. (Optional) Verify the package:\n\n ```sh\n twine check dist/*\n ```\n\n4. Upload the package to PyPI:\n\n ```sh\n python -m twine upload dist/*\n ```\n\n## Licence\n\nThis project is licensed under the MIT License.\n\n## Proyect Status\n\nThis project is under development\n\n## Contribution \ud83d\udc97\n\nIf you find value in this project and would like to show your support, please consider making a donation via PayPal:\n\n[Donate on PayPal](https://paypal.me/martinezwilmer?country.x=DO&locale.x=es_XC)\n\nYour generosity helps us to continue improving and maintaining this project. We appreciate every contribution, however small. Thanks for being part of our community!\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2025 Wilmer Martinez Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Python library to connect with Alanube API",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/wilmerm/alanube-python",
"Issues": "https://github.com/wilmerm/alanube-python/issues",
"Repository": "https://github.com/wilmerm/alanube-python"
},
"split_keywords": [
"alanube",
" api",
" dgii",
" ncf",
" ncf-e",
" electronic billing",
" electronic bill",
" billing",
" bill",
" invoice",
" facturaci\u00f3n electr\u00f3nica",
" factura",
" factura electr\u00f3nica"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5b9958a497d14211b1fb57c57ea2ec9f57ab2ee8788a9ac44a407dff295617ca",
"md5": "8dd8b0154303caa865a0bd081ab1fcad",
"sha256": "606f949344992424b1a8dc4ce63c7a2195dd3e1401454e6c2a4432fa09d0dc75"
},
"downloads": -1,
"filename": "alanube-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8dd8b0154303caa865a0bd081ab1fcad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 17497,
"upload_time": "2025-01-30T04:48:26",
"upload_time_iso_8601": "2025-01-30T04:48:26.864396Z",
"url": "https://files.pythonhosted.org/packages/5b/99/58a497d14211b1fb57c57ea2ec9f57ab2ee8788a9ac44a407dff295617ca/alanube-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "913625e2fbcf688949664ff5d32e0ba085135621f30728ef39a87cbdf3753b6e",
"md5": "e52be7fa5d1f6c24edc631f706de8346",
"sha256": "db15013ecf9385a4e1505f2b275f9b23521c50188505845e1e41f7e9dfe04673"
},
"downloads": -1,
"filename": "alanube-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "e52be7fa5d1f6c24edc631f706de8346",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 17645,
"upload_time": "2025-01-30T04:48:28",
"upload_time_iso_8601": "2025-01-30T04:48:28.050790Z",
"url": "https://files.pythonhosted.org/packages/91/36/25e2fbcf688949664ff5d32e0ba085135621f30728ef39a87cbdf3753b6e/alanube-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-30 04:48:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wilmerm",
"github_project": "alanube-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "requests",
"specs": []
}
],
"lcname": "alanube"
}
