IOTA API library for Python
Project description
.. image:: https://travis-ci.org/iotaledger/iota.lib.py.svg?branch=master
:target: https://travis-ci.org/iotaledger/iota.lib.py
.. image:: https://readthedocs.org/projects/pyota/badge/?version=latest
:target: http://pyota.readthedocs.io/en/latest/?badge=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 `Slack`_.
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]
.. _readme-installing-from-source:
Installing from Source
======================
#. `Create virtualenv`_ (recommended, but not required).
#. ``git clone https://github.com/iotaledger/iota.lib.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`_::
pip install tox
tox
=============
Documentation
=============
PyOTA's documentation is available on `ReadTheDocs`_.
If you are :ref:`installing from source <readme-installing-from-source>`, 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 ``docs`` directory::
cd docs
#. Build the documentation::
make html
.. _Create virtualenv: https://realpython.com/blog/python/python-virtual-environments-a-primer/
.. _PyOTA Bug Tracker: https://github.com/iotaledger/iota.lib.py/issues
.. _ReadTheDocs: https://pyota.readthedocs.io/
.. _Slack: https://slack.iota.org/
.. _dedicated forum: https://forum.iota.org/
.. _official API: https://iota.readme.io/
.. _tox: https://tox.readthedocs.io/
:target: https://travis-ci.org/iotaledger/iota.lib.py
.. image:: https://readthedocs.org/projects/pyota/badge/?version=latest
:target: http://pyota.readthedocs.io/en/latest/?badge=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 `Slack`_.
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]
.. _readme-installing-from-source:
Installing from Source
======================
#. `Create virtualenv`_ (recommended, but not required).
#. ``git clone https://github.com/iotaledger/iota.lib.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`_::
pip install tox
tox
=============
Documentation
=============
PyOTA's documentation is available on `ReadTheDocs`_.
If you are :ref:`installing from source <readme-installing-from-source>`, 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 ``docs`` directory::
cd docs
#. Build the documentation::
make html
.. _Create virtualenv: https://realpython.com/blog/python/python-virtual-environments-a-primer/
.. _PyOTA Bug Tracker: https://github.com/iotaledger/iota.lib.py/issues
.. _ReadTheDocs: https://pyota.readthedocs.io/
.. _Slack: https://slack.iota.org/
.. _dedicated forum: https://forum.iota.org/
.. _official API: https://iota.readme.io/
.. _tox: https://tox.readthedocs.io/
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
PyOTA-2.0.3.tar.gz
(5.5 MB
view details)
Built Distribution
PyOTA-2.0.3-py2.py3-none-any.whl
(103.8 kB
view details)
File details
Details for the file PyOTA-2.0.3.tar.gz.
File metadata
- Download URL: PyOTA-2.0.3.tar.gz
- Upload date:
- Size: 5.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 695fa222c2ddd6df30f361f4b42be684d8c7a5f57e8bfac0b71e066df1f86d50 |
|
| MD5 | a587e35eaab73d824015c6db974193fe |
|
| BLAKE2b-256 | 73c8bd6176d17b82a240800d3b33d33800b4844d96e5b4944c50339097ccee4f |
File details
Details for the file PyOTA-2.0.3-py2.py3-none-any.whl.
File metadata
- Download URL: PyOTA-2.0.3-py2.py3-none-any.whl
- Upload date:
- Size: 103.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e13f77704ce1523da4eb33ba0a282361c59d1740c9c6790e7874959b8e83a9ba |
|
| MD5 | 6a0ce83962f6bf94efbb49638419c1ae |
|
| BLAKE2b-256 | c09cdc5d4419aeedbdaaae2f1ecbecd4ddd7e925b45b2f67ce99422705745dbc |
