https://github.com/getlago/lago-python-client
Python wrapper for the Lago Rest API
https://github.com/getlago/lago-python-client
Last synced: 2 months ago
JSON representation
Python wrapper for the Lago Rest API
- Host: GitHub
- URL: https://github.com/getlago/lago-python-client
- Owner: getlago
- License: mit
- Created: 2022-05-11T19:01:07.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-28T11:03:15.000Z (3 months ago)
- Last Synced: 2025-03-30T22:09:47.134Z (2 months ago)
- Language: Python
- Homepage:
- Size: 528 KB
- Stars: 23
- Watchers: 5
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Lago Python Client
This is a python wrapper for Lago API
[](https://badge.fury.io/py/lago-python-client)
[](https://spdx.org/licenses/MIT.html)
## Current Releases
| Project | Release Badge |
|--------------------|-----------------------------------------------------------------------------------------------------|
| **Lago** | [](https://github.com/getlago/lago/releases) |
| **Lago Python Client** | [](https://github.com/getlago/lago-python-client/releases) |
## Installation
Install the lago-python-client via pip from PyPI:
$ python -m pip install "lago-python-client"
(Alternative) Install the lago-python-client via [poetry](https://python-poetry.org/) from PyPI:
$ poetry add "lago-python-client"
## Usage
Check the [lago API reference](https://doc.getlago.com/docs/api/intro)
## Development
### Install the dependencies
```bash
python -m pip install --upgrade pip setuptools wheel
python -m pip install .[test]
```
### Run tests
```bash
pytest
```
## Documentation
The Lago documentation is available at [doc.getlago.com](https://doc.getlago.com/docs/api/intro).
## Changelog
* [#55](https://github.com/getlago/lago-python-client/pull/55) -- Error handling (`LagoApiError`)
Example, creating wallet:
```
try:
response = client.wallets().create(wallet)
except LagoApiError as error:
do_something(status=error.status_code)
```
### Available properties:
```
>>> error.status_code
422
>>> error.detail
'Unprocessable Entity'
>>> error.headers
{'X-Frame-Options': 'SAMEORIGIN', 'X-XSS-Protection': '0', 'X-Content-Type-Options': 'nosniff', 'X-Download-Options': 'noopen', 'X-Permitted-Cross-Domain-Policies': 'none', 'Referrer-Policy': 'strict-origin-when-cross-origin', 'Content-Type': 'application/json; charset=utf-8', 'Cache-Control': 'no-cache', 'X-Request-Id': '613e7542-b29e-4224-bd19-a16dd1bfa62b', 'X-Runtime': '1.024304', 'Vary': 'Origin', 'Transfer-Encoding': 'chunked'}
>>> error.response
{'status': 422, 'error': 'Unprocessable Entity', 'code': 'validation_errors', 'error_details': {'customer': ['wallet_already_exists']}}
>>> error.response['error_details']['customer'][0]
'wallet_already_exists'
>>> error.url
'http://localhost:3000/api/v1/wallets'
```
## Contributing
The contribution documentation is available [here](https://github.com/getlago/lago-python-client/blob/main/CONTRIBUTING.md)
## License
Lago Python client is distributed under [MIT license](LICENSE).