This is the official Python library for the IOTA Core.
It implements both the official API, as well as newly-proposed functionality (such as signing, bundles, utilities and conversion).
If you want to get involved in the community, need help with getting setup, have any issues related with the library or just want to discuss Blockchain, Distributed Ledgers and IoT with other people, feel free to join our Discord.
You can also ask questions on our dedicated forum.
If you encounter any issues while using PyOTA, please report them using the PyOTA Bug Tracker.
PyOTA is compatible with Python 3.6, 3.5 and 2.7.
To install the latest version:
pip install pyota
PyOTA has an optional C extension that improves the performance of its cryptography features significantly (speedups of 60x are common!).
To install this extension, use the following command:
pip install pyota[ccurl]
- Create virtualenv (recommended, but not required).
git clone https://github.com/iotaledger/iota.lib.py.gitpip install -e .
To run unit tests after installing from source:
python setup.py test
PyOTA is also compatible with tox, which will run the unit tests in different virtual environments (one for each supported version of Python).
To run the unit tests, it is recommended that you use the detox library. detox speeds up the tests by running them in parallel.
Install PyOTA with the test-runner extra to set up the necessary
dependencies, and then you can run the tests with the detox command:
pip install -e .[test-runner] detox -v
PyOTA's documentation is available on ReadTheDocs.
If you are installing from source (see above), you can also build the documentation locally:
Install extra dependencies (you only have to do this once):
pip install '.[docs-builder]'
Tip
To install the CCurl extension and the documentation builder tools together, use the following command:
pip install '.[ccurl,docs-builder]'
Switch to the
docsdirectory:cd docs
Build the documentation:
make html