Client

Install Package with pip

To install the arkecosystem-client package from the feat/mainsail branch, use the following command:

pip install git+https://github.com/ArkEcosystem/python-client.git@feat/mainsail

Alternatively, you can add it directly to your requirements.txt file:

git+https://github.com/ArkEcosystem/python-client.git@feat/mainsail#egg=arkecosystem-client

Then, install the dependencies:

pip install -r requirements.txt

Development

  1. Fork the package.
  2. Clone your forked repository.
git clone https://github.com/ArkEcosystem/python-client
  1. Next, move into the cloned directory.
cd python-client
  1. Switch to the feat/mainsail branch.
git checkout feat/mainsail
  1. Create and activate a virtual environment to ensure no name clashes occur.
# With virtualenv (on Unix and macOS)
virtualenv venv
source venv/bin/activate

# With virtualenv (on Windows)
virtualenv venv
.\venv\Scripts\activate.bat
  1. Install the dependencies listed in the setup.py file.
pip install -r requirements.txt
  1. Dependencies are now installed. You can now run the tests to see if everything is running as it should.
pytest