Python library for communicating with the Celsius Network API
Project description
myb-celsius-network-api
An API client for the Celsius Network (Wallet) API
Installation
The package is availble via PyPi and can be installed with the following command:
pip3 install myb-celsius-network-api
To install it from the repo, clone the repo and cd into the directory:
git clone https://github.com/mine-your-business/myb-celsius-network-api.git
cd myb-celsius-network-api
You can install this library with pip
:
pip3 install .
Testing
Celsius Network offers a number of different "partner" integrations. The one this library leverages is the "Omnibus Treasury" partnership which is documented here.
Instructions on how to acquire a partner token are described in that document and it links to a guide on generating an API key.
Postman Docs for their API can be found here.
Before tests can be run, a local_env_vars.py
file needs to be created in the tests
folder. You can use the local_env_vars_example.py
file as an example for the content - just be sure to fill out the API key and token data with actual secrets from Celsius Network.
To run tests, simply run the following command:
pytest --verbose
To print output of tests, run the following:
pytest --verbose -s
Releases
Releases should follow a Semantic Versioning scheme.
When changes have been made that warrant a new release that should be published, modify the __version__
in setup.py
After the change is merged to the main
branch, go to releases and Draft a new release
. The Tag version
should follow the pattern v1.0.0
and should Target
the main
branch.
The Release title
should not include the v
from the tag and should have a reasonably detailed description of the new release's changes.
Once the release has been published, the .github/workflows/python-publish.yml
GitHub Actions Workflow should trigger and automatically upload the new version to PyPi]pypi using GitHub secrets credentials stored with the Mine Your Business GitHub Organization.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for myb-celsius-network-api-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f6b93c813c980ed138ed35b3536be404ca9d22fd4563fdd04cac69a494cad350 |
|
MD5 | d1a5e855a6c7708dc1f7595310b621e2 |
|
BLAKE2b-256 | b10a89374c95a65ee0eb9f9dc735400fbaadd2a0aab3a6b0fa731ab1446e4120 |
Hashes for myb_celsius_network_api-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57bf4982180ccc27d7d9d569eb25fc016dd8553fa2e20eabc0a543adb934ade5 |
|
MD5 | a9d43023c584621875498bd346283685 |
|
BLAKE2b-256 | 079a92d841dc28cd23d3982b47a63fbb40b6e8cddf3058bcaa676a95ac4f695c |