Ark Python - Client

A simple Python API client for the Ark Blockchain.

Lead Maintainer: Brian Faust

Guide for contributing

1. Fork the repository on GitHub.
2. 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.
3. Make your change.
4. Write tests that demonstrate your bug or feature.
5. Run the entire test suite again, confirming that all tests pass including the ones you just added.
6. 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 the ArkEcosystem Slack.

Development

Prerequisites

• Python >= 3.7

Setup

1. Create a virtual environment

Run the following command to create a virtual environment for the project:

python -m venv venv

2. Activate the virtual environment

On macOS/Linux:

source venv/bin/activate

On Windows

.\venv\Scripts\activate

3. Upgrade pip and setuptools

Ensure you have the latest versions of pip and setuptools:

pip install --upgrade pip setuptools

4. Install the dependencies

Install all necessary dependencies from the requirements.txt file:

pip install -r requirements.txt

5. Install the package in development mode

Run the following command to install the package in development mode:

python setup.py develop

6. Run the tests

Use pytest to run the tests and ensure everything is working correctly:

python setup.py test

Or directly with pytest:

pytest

Documentation

You can find installation instructions and detailed instructions on how to use this package at the dedicated documentation site.

Security

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.

Credits

This project exists thanks to all the people who contribute.

License

MIT © ARK Ecosystem