Merge pull request #87 from iotaledger/release/2.0.1

Release/2.0.1

.gitignore

@@ -7,6 +7,9 @@ PyOTA.egg-info/*
 build/*
 dist/*
 
+# Sphinx documentation
+docs/_build/
+
 # Created by ``setup.py test``.
 .eggs/*
 
@@ -18,4 +21,4 @@ dist/*
 # Note:  For environment- or IDE-specific metadata (e.g., .DS_Store, .idea, etc.
 # you can add these to your own "global" .gitignore file.
 # https://help.github.com/articles/ignoring-files/#create-a-global-gitignore
-#
+#

MANIFEST.in

@@ -1,3 +1,4 @@
 include LICENSE
+include README.rst
 recursive-include examples *.py
 recursive-include test *.py *.csv

README.rst

@@ -1,6 +1,9 @@
-.. image:: https://travis-ci.org/iotaledger/iota.lib.py.svg?branch=develop
+.. 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
 =====

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = PyOTA
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,172 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# PyOTA documentation build configuration file, created by
+# sphinx-quickstart on Tue Oct  3 20:46:23 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'PyOTA'
+copyright = '2017, Phoenix Zerin'
+author = 'Phoenix Zerin'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = ''
+# The full version, including alpha/beta/rc tags.
+release = ''
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+# html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+        'donate.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'PyOTAdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'PyOTA.tex', 'PyOTA Documentation',
+     'Phoenix Zerin', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'pyota', 'PyOTA Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'PyOTA', 'PyOTA Documentation',
+     author, 'PyOTA', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/getting_started.rst

@@ -0,0 +1,84 @@
+Installation
+============
+PyOTA is compatible with Python 3.6, 3.5 and 2.7.
+
+Install PyOTA using `pip`:
+
+.. code-block:: bash
+
+   pip install pyota[ccurl]
+
+.. note::
+
+   The ``[ccurl]`` extra installs the optional `PyOTA-CCurl extension`_.
+
+   This extension boosts the performance of certain crypto operations
+   significantly (speedups of 60x are common).
+
+Getting Started
+===============
+In order to interact with the IOTA network, you will need access to a node.
+
+You can:
+
+- `Run your own node.`_
+- `Use a light wallet node.`_
+- `Use the sandbox node.`_
+
+Note that light wallet nodes often disable certain features like PoW for
+security reasons.
+
+Once you've gotten access to an IOTA node, initialize an :py:class:`iota.Iota`
+object with the URI of the node, and optional seed:
+
+.. code-block:: python
+
+   from iota import Iota
+
+   # Generate a random seed.
+   api = Iota('http://localhost:14265')
+
+   # Specify seed.
+   api = Iota('http://localhost:14265', 'SEED9GOES9HERE')
+
+Test your connection to the server by sending a ``getNodeInfo`` command:
+
+.. code-block:: python
+
+   print(api.get_node_info())
+
+You are now ready to send commands to your IOTA node!
+
+Using the Sandbox Node
+----------------------
+To connect to the sandbox node, you will need to inject a
+:py:class:`SandboxAdapter` into your :py:class:`Iota` object.  This will modify
+your API requests so that they contain the necessary authentication metadata.
+
+.. code-block:: python
+
+   from iota.adapter.sandbox import SandboxAdapter
+
+   api = Iota(
+     # To use sandbox mode, inject a ``SandboxAdapter``.
+     adapter = SandboxAdapter(
+       # URI of the sandbox node.
+       uri = 'https://sandbox.iotatoken.com/api/v1/',
+
+       # Access token used to authenticate requests.
+       # Contact the node maintainer to get an access token.
+       auth_token = 'auth token goes here',
+     ),
+
+     # Seed used for cryptographic functions.
+     # If null, a random seed will be generated.
+     seed = b'SEED9GOES9HERE',
+   )
+
+.. _forum: https://forum.iota.org/
+.. _official api: https://iota.readme.io/
+.. _pyota-ccurl extension: https://pypi.python.org/pypi/PyOTA-CCurl
+.. _run your own node.: http://iotasupport.com/headlessnode.shtml
+.. _slack: http://slack.iota.org/
+.. _use a light wallet node.: http://iotasupport.com/lightwallet.shtml
+.. _use the sandbox node.: http://dev.iota.org/sandbox

docs/index.rst

@@ -0,0 +1,13 @@
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   getting_started
+   types
+
+.. note::
+   **🚧 PyOTA documentation is still under construction. 🚧**
+
+   Follow https://github.com/iotaledger/iota.lib.py/issues/78 for updates.
+
+.. include:: ../README.rst

docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=PyOTA
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd