ICE3X Python Library
This ice3x library is a Python package compliant with the ICE3X APi version 2.
This package is essentially a port of the official PHP client.
Quickstart
The ICE3X API has two broad categories of resources, protected and unprotected resources.
In order to access protected resources one needs to create a private and public key under the account management section of their platform.
Sync client
from ice3x.clients.sync import IceCubedSyncClient
api_key = 'public key'
secret = 'private key'
client = IceCubedSyncClient(api_key=api_key, secret=secret)
client.get_public_trade_list()
Async client
from __future__ import annotations
from twisted.internet import reactor
from ice3x.clients.asynchronous import IceCubedAsyncClient
api_key = 'public key'
secret = 'private key'
client = IceCubedAsyncClient(api_key=api_key, secret=secret)
def print_data(data: dict) -> None:
"""prints the json response from an API call"""
print(data)
d = client.get_public_trade_list()
d.addBoth(print_data)
reactor.run()
Installation
The library can be installed from PyPi as follows.
pip install ice3x
The async client is an optional extra and may be installed as follows.
pip install ice3x[async]
To install the version on this repository follow the steps below.
git clone https://github.com/BradleyKirton/ice3x
cd ice3x
python -m venv env # virtualenv env
source env/bin/activate
pip install . #pip install .[async] for the async client
Developement
Clone the repo and install the package with it's development requirements.
git clone https://github.com/BradleyKirton/ice3x
cd ice3x
pipenv install -e .[dev]
make test
TODO
Note this library is still in beta.
- Write documentation
Metadata
Release files for ice3x 0.2.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ice3x-0.2.7.tar.gz | 7.3 kB | Without provenance | Details for ice3x-0.2.7.tar.gz |
Release files / ice3x-0.2.7.tar.gz
| Download URL | ice3x-0.2.7.tar.gz |
|---|---|
| Size | 7.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8efd15ac78232193ff0c809954d7b5056f7549e015b423a17bb4c925c2b79e10
|
|
BLAKE2b-256 checksum How to use checksums |
3cdc97a794c9807cb27d347839c5832d1165fca391307c2a3eae2f0a2e53b0d8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3
|
Security for ice3x 0.2.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.