Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orsinium-labs/bux
Unofficial Python SDK and CLI for BUX Zero API
https://github.com/orsinium-labs/bux
api bux bux0 buxzero python python3 sdk
Last synced: about 2 months ago
JSON representation
Unofficial Python SDK and CLI for BUX Zero API
- Host: GitHub
- URL: https://github.com/orsinium-labs/bux
- Owner: orsinium-labs
- License: mit
- Created: 2021-07-27T10:10:54.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-08-30T11:19:15.000Z (over 3 years ago)
- Last Synced: 2024-10-28T22:14:35.992Z (2 months ago)
- Topics: api, bux, bux0, buxzero, python, python3, sdk
- Language: Python
- Homepage:
- Size: 146 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bux
Python SDK and CLI for BUX Zero ([getbux.com](https://getbux.com/)).
Features:
+ 100% type safe.
+ Multiple network libraries supported.
+ Both sync and async APIs.
+ [Open-world assumption](https://en.wikipedia.org/wiki/Open-world_assumption), changes in API won't break the library.
Supported networking libraries:
+ [requests](https://docs.python-requests.org/en/master/)
+ [httpx](https://www.python-httpx.org/)
+ [aiohttp](https://docs.aiohttp.org/en/stable/)
## Disclaimer
+ This is an unofficial library! I'm not affiliated with BUX B.V., don't work there, don't know anyone who works there. BUX B.V. is not responsible for any bugs in this library and does not provide technical support for the library usage or development.
+ This is an OSS distributed under MIT License. I don't provide warranty nor technical support for the project. I'm not responsible for any bugs or issues you may encounter. See [LICENSE](./LICENSE).
+ The library uses public API, in a sense that it is publicly available and all you need to get access to it is an account (which you own, thanks to GDPR). However, this API is not documented and can be broken by BUX B.V. at any moment.
+ Keep in mind that [BUX Client Agreement](https://getbux.com/documents/20210705-BUX-Zero-Client-Agreement-EN.pdf) forbids placing orders in other way than the official mobile app: "You can only provide Orders to BUX through a mobile application". However, it doesn't say anything about other API endpoints, like getting historical data. Hence all endpoints, except those that place orders, are legal.
+ So, use it at your own risk! If you found a bug, you're the only one who can fix it. Please, when you fix something, contribute it back, the project is open for contributions.
## Getting started
### Installation
Install bux and the networking library you want to use. If you don't know which one you need, just use requests.
```bash
python3 -m pip install bux requests
```
### Getting token
To make requests to the API, you need to get token. The library provides a CLI command specifically for this:
```bash
python3 -m bux get-token
```
Keep this token in secret! This is all you need to get full access to the API.
## CLI Usage
Show available commands:
```bash
python3 -m bux --help
```
Every command requires `--token` argument. It's up to you how you store it. For example, in a file:
```bash
echo "MY_TOKEN" > .token
python3.9 -m bux info --token $(cat .token) NL0011540547
```
## SDK Usage
```python
import bux
api = bux.UserAPI(token=your_token)
me = api.me().requests()
```
Every API endpoint is represented as a method of `UserAPI`. Every such method returns a `bux.Request` method which provides a method for every supported networking library (`requests`, `httpx`, and so on). Just call this method and you get the result. The result is represented as `bux.Response` object which is just a `dict` with some additional type-safe properties.
See the source code for CLI commands ([bux/_commands](./bux/_commands)) for the real-world usage examples.