IOTA API library for Python
Project description
PyOTA
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).
Join the Discussion
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.
If you encounter any issues while using PyOTA, please report them using the PyOTA Bug Tracker.
Dependencies
PyOTA is compatible with Python 3.7 and 3.6.
Install PyOTA
To install the latest version:
pip install pyota
Optional C Extension
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]
Optional Local Pow
To perform proof-of-work locally without relying on a node, you can install an extension module called PyOTA-PoW .
Specifiy the local_pow=True argument when creating an api instance, that will redirect all attach_to_tangle API calls to an interface function in the pow package.
To install this extension, use the following command:
pip install pyota[pow]
Alternativley you can take a look on the repository Ccurl.interface.py to install Pyota-PoW. Follow the steps depicted in the repo’s README file.
Installing from Source
Create virtualenv (recommended, but not required).
git clone https://github.com/iotaledger/iota.py.git
pip install -e .
Running Unit Tests
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 -p argument. This 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 tox command:
pip install -e .[test-runner] tox -v -p all
Documentation
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]
Switch to the docs directory:
cd docs
Build the documentation:
make html
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file PyOTA-3.0.0b2.tar.gz.
File metadata
- Download URL: PyOTA-3.0.0b2.tar.gz
- Upload date:
- Size: 5.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1530325826a6094748b8943524ba9678a8e6d35e6266dbff84e3988381345c57 |
|
| MD5 | 34b46d511a01b35722deae5930d9ff2f |
|
| BLAKE2b-256 | f3c8ffac950cdc25c77ced43962ea407430468ed4e6da3187426a53055e53dbc |
File details
Details for the file PyOTA-3.0.0b2-py2.py3-none-any.whl.
File metadata
- Download URL: PyOTA-3.0.0b2-py2.py3-none-any.whl
- Upload date:
- Size: 132.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 63ab6a5087790698366ebcf1bf6a89476a47cf9318fff9f5eb2dc8e81dbe66b5 |
|
| MD5 | 24060c1906fd7c5f9a13b6752d70e4d6 |
|
| BLAKE2b-256 | 0dcebd934caed98313c48f2a0af8ab613af0b90eba389fc72bc2699cc6ca1265 |
