Merge pull request #2 from iotaledger/develop

1.0.0-beta1

Author: todofixthis

.gitignore

@@ -0,0 +1,22 @@
+# Python metadata
+*.py[co]
+
+# Generated distribution files.
+# :see: https://packaging.python.org/distributing/
+build/*
+dist/*
+PyOTA.egg-info/*
+*.so
+
+# Virtualenvs for unit tests.
+# :see: https://tox.readthedocs.io/en/latest/
+.tox/*
+
+# Generated documentation files.
+docs/_build
+
+#
+# Note:  For environment- or IDE-specific metadata (e.g., .DS_Store, .idea, etc.
+#   you can add these to your own "global" .gitignore file.
+# :see: https://help.github.com/articles/ignoring-files/#create-a-global-gitignore
+#

.travis.yml

@@ -0,0 +1,7 @@
+language: python
+python:
+  - "2.7"
+  - "3.5"
+  - "3.6-dev"
+install: "pip install ."
+script: "nosetests"

README.md

@@ -0,0 +1,69 @@
+.. image:: https://travis-ci.org/iotaledger/pyota.svg?branch=develop
+   :target: https://travis-ci.org/iotaledger/pyota
+
+=====
+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).
+
+.. warning::
+   This is pre-release software!
+   There may be performance and stability issues.
+
+   Please report any issues using the `PyOTA Bug Tracker`_.
+
+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`_.
+
+============
+Dependencies
+============
+PyOTA is compatible with Python 3.6, 3.5 and 2.7.
+
+============
+Installation
+============
+To install the latest stable version::
+
+  pip install pyota
+
+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`_::
+
+  pip install tox
+  tox
+
+=============
+Documentation
+=============
+For the full documentation of this library, please refer to the
+`official API`_
+
+
+.. _Create virtualenv: https://virtualenvwrapper.readthedocs.io/
+.. _SWIG: http://www.swig.org/download.html
+.. _Slack: http://slack.iotatoken.com/
+.. _dedicated forum: http://forum.iotatoken.com/
+.. _official API: https://iota.readme.io/
+.. _PyOTA Bug Tracker: https://github.com/iotaledger/iota.lib.py/issues
+.. _tox: https://tox.readthedocs.io/

README.rst

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+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/Makefile

@@ -0,0 +1,165 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# PyOTA documentation build configuration file, created by
+# sphinx-quickstart on Mon Dec  5 21:20:31 2016.
+#
+# 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 = [
+  'sphinx.ext.autodoc',
+  'sphinx.ext.viewcode',
+]
+
+# 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 = '2016, IOTA Foundation'
+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.
+#
+
+# # :see: http://stackoverflow.com/a/2073599/
+# from pkg_resources import require
+# __version__ = require('PyOTA')[0].version
+#
+# # The short X.Y version.
+# version = __version__
+# # The full version, including alpha/beta/rc tags.
+# release = __version__
+
+# 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']
+
+
+# -- 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/conf.py

@@ -0,0 +1,20 @@
+.. PyOTA documentation master file, created by
+   sphinx-quickstart on Mon Dec  5 21:20:31 2016.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to PyOTA's documentation!
+=================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/index.rst

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=PyOTA
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the 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

docs/make.bat

@@ -0,0 +1,3 @@
+# coding=utf-8
+from __future__ import absolute_import, division, print_function, \
+  unicode_literals