Skip to main content

IOTA API library for Python

Project description

https://travis-ci.org/iotaledger/iota.lib.py.svg?branch=master https://readthedocs.org/projects/pyota/badge/?version=latest

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.

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.

Dependencies

PyOTA is compatible with Python 3.6, 3.5 and 2.7.

Installation

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]

Installing from Source

  1. Create virtualenv (recommended, but not required).

  2. git clone https://github.com/iotaledger/iota.lib.py.git

  3. 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 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

Documentation

PyOTA’s documentation is available on ReadTheDocs.

If you are installing from source (see above), you can also build the documentation locally:

  1. Install extra dependencies (you only have to do this once):

    pip install '.[docs-builder]'
  2. Switch to the docs directory:

    cd docs
  3. Build the documentation:

    make html

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

PyOTA-2.0.7.tar.gz (5.5 MB view details)

Uploaded Source

Built Distribution

PyOTA-2.0.7-py2.py3-none-any.whl (109.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file PyOTA-2.0.7.tar.gz.

File metadata

  • Download URL: PyOTA-2.0.7.tar.gz
  • Upload date:
  • Size: 5.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.3

File hashes

Hashes for PyOTA-2.0.7.tar.gz
Algorithm Hash digest
SHA256 6be4987fc61da7186b6c663dbf22c877dde72556b7a8c68c4571ea0e0145c3c4
MD5 98f0926652e7117d0d955d093ce36016
BLAKE2b-256 a78c5fbea2e6678f44b59a0af971529be431b50be5a66cf9190eefa9c9d3c331

See more details on using hashes here.

File details

Details for the file PyOTA-2.0.7-py2.py3-none-any.whl.

File metadata

  • Download URL: PyOTA-2.0.7-py2.py3-none-any.whl
  • Upload date:
  • Size: 109.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.3

File hashes

Hashes for PyOTA-2.0.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a0b7d687e4ac632aadb1a0a48a56af7904f3587cd92bc48dbc35ba395a4dd831
MD5 184c9dc34fc73a622043cc48b220316e
BLAKE2b-256 a4536d816de19b01ac1c54c73b0146c63d88b8a7a280a3d8900bbd40a08aa0b6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page