A simple Python API client for the ARK Blockchain.
We will not be accepting new PRs until we are happy with the base of the client and until it has good test coverage. We'll let you know on our #python Slack channel once we'll accept PRs again.
For current develop branch installation please use the following:
pip install -e git://github.com/ArkEcosystem/python-client.git@develop#egg=ark-client
Before you start contributing please take some time and check our official Python Development Guidelines which follow the widely accepted PEP8 Python Style Guide. 🖋
- Fork the repository on GitHub.
- Run the tests to confirm they all pass on your system. If they don’t, you’ll need to investigate why they fail. If you’re unable to diagnose this yourself raise it as a bug report.
- Make your change.
- Write tests that demonstrate your bug or feature.
- Run the entire test suite again, confirming that all tests pass including the ones you just added.
- Send a GitHub Pull Request. GitHub Pull Requests are the expected method of code collaboration on this project.
If you have any questions, requests or ideas open an issue or ask us in #python on ARK's Slack.
from ark import ArkClient
client = ArkClient('http://127.0.0.1:4003/api/')
delegates = client.delegates.all()
or for V1:
from ark import ArkClient
client = ArkClient('http://127.0.0.1:4002/api/', api_version='v1')
delegates = client.delegates.all()
You can find installation instructions and detailed instructions on how to use this package at the dedicated documentation site.
If you discover a security vulnerability within this package, please send an e-mail to security@ark.io. All security vulnerabilities will be promptly addressed.
To install all development requiremenets, simply run pip install .[dev]
.