https://github.com/hivesolutions/budy-api
Budy API Python client
https://github.com/hivesolutions/budy-api
api budy client python rest
Last synced: 23 days ago
JSON representation
Budy API Python client
- Host: GitHub
- URL: https://github.com/hivesolutions/budy-api
- Owner: hivesolutions
- Created: 2015-01-11T11:47:32.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2026-05-31T20:10:05.000Z (23 days ago)
- Last Synced: 2026-05-31T21:23:00.746Z (23 days ago)
- Topics: api, budy, client, python, rest
- Language: Python
- Homepage: http://budy-api.hive.pt
- Size: 170 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# [Budy API](http://budy-api.hive.pt)
[Budy](http://budy.hive.pt) API Python client, to be used for simple synchronous integration.
## Configuration
| Name | Type | Default | Description |
| ----------------- | ----- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| **BUDY_BASE_URL** | `str` | `http://localhost:8080/api/` | The base URL that is going to be used for API connections. |
| **BUDY_COUNTRY** | `str` | `US` | The country as an ISO 3166-1 to be used for API interactions. |
| **BUDY_CURRENCY** | `str` | `USD` | The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code that describes the currency to be used for API interactions. |
| **BUDY_USERNAME** | `str` | `None` | The username to be used for authentication. |
| **BUDY_PASSWORD** | `str` | `None` | The password to be user for authentication. |
## Example
```python
import budy
api = budy.API(
base_url="https://budy.my_instance.com/api/",
username="my_user",
password="my_password"
)
voucher = api.create_value_voucher(10)
print(voucher["key"])
```
## License
Budy API is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).
## Build Automation
[](https://github.com/hivesolutions/budy-api/actions)
[](https://coveralls.io/r/hivesolutions/budy-api?branch=master)
[](https://pypi.python.org/pypi/budy-api)
[](https://www.apache.org/licenses/)