From 92fd0a9d24378d01d87dfa6fd0ec5a42edfe8308 Mon Sep 17 00:00:00 2001
From: "F. Eugene Aumson" <feuGeneA@users.noreply.github.com>
Date: Wed, 10 Oct 2018 12:14:20 -0400
Subject: feat: project stub for python order utilities

An empty project, with respect to functionality, but one configured with
a test framework, linters, CI integration, etc.

https://app.asana.com/0/836857747873847/839549782781239/f
---
 python-packages/order_utils/src/conf.py            | 50 ++++++++++++++++++++++
 python-packages/order_utils/src/index.rst          | 22 ++++++++++
 .../order_utils/src/zero_ex/__init__.py            |  1 +
 .../src/zero_ex/order_utils/__init__.py            |  1 +
 .../src/zero_ex/order_utils/signature_utils.py     | 13 ++++++
 python-packages/order_utils/src/zero_ex/py.typed   |  0
 6 files changed, 87 insertions(+)
 create mode 100644 python-packages/order_utils/src/conf.py
 create mode 100644 python-packages/order_utils/src/index.rst
 create mode 100644 python-packages/order_utils/src/zero_ex/__init__.py
 create mode 100644 python-packages/order_utils/src/zero_ex/order_utils/__init__.py
 create mode 100644 python-packages/order_utils/src/zero_ex/order_utils/signature_utils.py
 create mode 100644 python-packages/order_utils/src/zero_ex/py.typed

(limited to 'python-packages/order_utils/src')

diff --git a/python-packages/order_utils/src/conf.py b/python-packages/order_utils/src/conf.py
new file mode 100644
index 000000000..f3f15967c
--- /dev/null
+++ b/python-packages/order_utils/src/conf.py
@@ -0,0 +1,50 @@
+"""Configuration file for the Sphinx documentation builder."""
+
+# Reference: http://www.sphinx-doc.org/en/master/config
+
+# pylint: disable=invalid-name
+# because these variables are not named in upper case, as globals should be.
+
+project = "order_utils.py"
+# pylint: disable=redefined-builtin
+copyright = "2018, ZeroEx, Intl."
+author = "F. Eugene Aumson"
+version = ""  # The short X.Y version
+release = ""  # The full version, including alpha/beta/rc tags
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.coverage",
+    "sphinx.ext.viewcode",
+]
+
+templates_path = ["doc_templates"]
+
+source_suffix = ".rst"
+# eg: source_suffix = [".rst", ".md"]
+
+master_doc = "index"  # The master toctree document.
+
+language = None
+
+exclude_patterns = []  # type: ignore
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+html_theme = "alabaster"
+
+html_static_path = ["doc_static"]
+# 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".
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "order_utilspydoc"
+
+# -- Extension configuration:
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {"https://docs.python.org/": None}
diff --git a/python-packages/order_utils/src/index.rst b/python-packages/order_utils/src/index.rst
new file mode 100644
index 000000000..cbc4c8409
--- /dev/null
+++ b/python-packages/order_utils/src/index.rst
@@ -0,0 +1,22 @@
+.. source for the sphinx-generated build/docs/web/index.html
+
+order_utils.py
+==============
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+.. automodule:: zero_ex.order_utils
+   :members:
+
+.. automodule:: zero_ex.order_utils.signature_utils
+   :members:
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/python-packages/order_utils/src/zero_ex/__init__.py b/python-packages/order_utils/src/zero_ex/__init__.py
new file mode 100644
index 000000000..c3ed1562a
--- /dev/null
+++ b/python-packages/order_utils/src/zero_ex/__init__.py
@@ -0,0 +1 @@
+"""0x Python API."""
diff --git a/python-packages/order_utils/src/zero_ex/order_utils/__init__.py b/python-packages/order_utils/src/zero_ex/order_utils/__init__.py
new file mode 100644
index 000000000..f014af0f6
--- /dev/null
+++ b/python-packages/order_utils/src/zero_ex/order_utils/__init__.py
@@ -0,0 +1 @@
+"""Order utilities for 0x applications."""
diff --git a/python-packages/order_utils/src/zero_ex/order_utils/signature_utils.py b/python-packages/order_utils/src/zero_ex/order_utils/signature_utils.py
new file mode 100644
index 000000000..7f4697106
--- /dev/null
+++ b/python-packages/order_utils/src/zero_ex/order_utils/signature_utils.py
@@ -0,0 +1,13 @@
+"""Signature utilities."""
+
+
+def ec_sign_order_hash():
+    """Signs an orderHash.
+
+    Returns its elliptic curve signature and signature type.  This method
+    currently supports TestRPC, Geth, and Parity above and below v1.6.6.
+
+    >>> ec_sign_order_hash()
+    'stub return value'
+    """
+    return "stub return value"
diff --git a/python-packages/order_utils/src/zero_ex/py.typed b/python-packages/order_utils/src/zero_ex/py.typed
new file mode 100644
index 000000000..e69de29bb
-- 
cgit