Metadata-Version: 2.1
Name: PyOTA
Version: 2.0.7
Summary: IOTA API library for Python
Home-page: https://github.com/iotaledger/iota.lib.py
Author: Phoenix Zerin
Author-email: phx@phx.ph
License: MIT
Keywords: iota,tangle,iot,internet of things,api,library,cryptocurrency,balanced ternary
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: filters
Requires-Dist: pysha3
Requires-Dist: requests[security] (>=2.4.1)
Requires-Dist: six
Requires-Dist: typing; python_version < "3.0"
Provides-Extra: ccurl
Requires-Dist: pyota-ccurl; extra == 'ccurl'
Provides-Extra: docs-builder
Requires-Dist: sphinx; extra == 'docs-builder'
Requires-Dist: sphinx-rtd-theme; extra == 'docs-builder'
Provides-Extra: test-runner
Requires-Dist: detox; extra == 'test-runner'
Requires-Dist: nose; extra == 'test-runner'
Requires-Dist: mock; (python_version < "3.0") and extra == 'test-runner'

.. 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 `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
======================

#. `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`_, 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:

#. 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/
.. _Discord: https://discord.gg/7Gu2mG5
.. _PyOTA Bug Tracker: https://github.com/iotaledger/iota.lib.py/issues
.. _ReadTheDocs: https://pyota.readthedocs.io/
.. _dedicated forum: https://forum.iota.org/
.. _detox: https://pypi.python.org/pypi/detox
.. _official API: https://iota.readme.io/
.. _tox: https://tox.readthedocs.io/


