Add docs and towncrier.

* Add sphinx and some other deps to make sphinx work better
* Update ci pipeline name to build
* Update gitignore to better ignore mypy

Author: adithyabsk

.github/workflows/main.yml

@@ -1,4 +1,4 @@
-name: ci
+name: build
 
 on:
   pull_request:

.gitignore

@@ -69,4 +69,4 @@ target/
 .idea/
 .python-version
 .DS_Store
-.mypy_cache/*
+*.mypy_cache/*

README.md

@@ -0,0 +1,116 @@
+.. image:: https://i.imgur.com/74CYw5g.png
+   :target: https://github.com/robinhood-unofficial/Robinhood
+   :alt: robinhood-logo
+
+-------------------------------------------------------------
+
+pyrh - Unofficial Robinhood API
+###############################
+
+.. image:: https://github.com/robinhood-unofficial/Robinhood/workflows/build/badge.svg?branch=master
+   :target: https://github.com/robinhood-unofficial/Robinhood/workflows/build/
+   :alt: build
+
+.. image:: https://img.shields.io/gitter/room/J-Robinhood/Lobby
+   :target: https://gitter.im/J-Robinhood/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+   :alt: Gitter
+
+.. image:: https://img.shields.io/github/license/robinhood-unofficial/Robinhood
+   :target: https://github.com/robinhood-unofficial/Robinhood/blob/master/LICENSE
+   :alt: GitHub
+
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/psf/black
+   :alt: Code style: black
+
+Python Framework to make trades with Unofficial Robinhood API. Supports Python 3.6+
+
+Quickstart
+**********
+
+.. code-block:: python
+
+   from pyrh import Robinhood
+
+   rh = Robinhood()
+   rh.login(username="YOUR_EMAIL", password="YOUR_PASSWORD")
+   rh.print_quote("AAPL")
+
+How To Install:
+***************
+
+.. code-block::
+
+   pip install pyrh
+
+Current Features
+****************
+
+* Placing buy orders (\ ``Robinhood.place_buy_order``\ )
+* Placing sell order (\ ``Robinhood.place_sell_order``\ )
+* Fetch and cancel orders (\ ``Robinhood.order_history`` and ``Robinhood.cancel_order``\ )
+* Quote information (\ ``Robinhood.quote_data``\ )
+* User portfolio data (\ ``Robinhood.portfolios``\ )
+* User positions data (\ ``Robinhood.positions``\ )
+* More coming soon
+
+Running example.ipynb_
+**********************
+
+.. _example.ipynb: https://github.com/robinhood-unofficial/Robinhood/blob/master/notebooks/example.ipynb
+
+* Install jupyter
+  .. code-block::
+
+     $ python --version # python 3.3+ for venv functionality
+     Python 3.7.6
+     $ python -m venv pyrh_env
+     $ source pyrh_env/bin/activate
+     (pyrh_env) $ pip install pyrh
+     (pyrh_env) $ pip install jupyter
+     (pyrh_env) $ jupyter notebook
+
+Then navigate to the example file linked above and run it.
+
+Data returned
+*************
+* Quote data
+
+  * Ask Price
+  * Ask Size
+  * Bid Price
+  * Bid Size
+  * Last trade price
+  * Previous close
+  * Previous close date
+  * Adjusted previous close
+  * Trading halted
+  * Updated at
+  * Historical Price
+
+* User portfolio data
+
+  * Adjusted equity previous close
+  * Equity
+  * Equity previous close
+  * Excess margin
+  * Extended hours equity
+  * Extended hours market value
+  * Last core equity
+  * Last core market value
+  * Market value
+  * Order history
+  * Dividend history
+
+* User positions data
+
+  * Securities owned
+
+* News
+
+Related
+*******
+
+* `robinhood-ruby <https://github.com/rememberlenny/robinhood-ruby>`_ - RubyGem for interacting with Robinhood API
+* `robinhood-node <https://github.com/aurbano/robinhood-node>`_ - NodeJS module to make trades with Robinhood Private API
+* See the original `blog post <https://medium.com/@rohanpai25/reversing-robinhood-free-accessible-automated-stock-trading-f40fba1e7d8b>`_.

README.rst

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+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,15 @@
+.. _changelog:
+
+Changelog
+#########
+
+.. towncrier release notes start
+
+pyrh 2.0 (2020-03-18)
+=====================
+- Fixed 2fa connection issues
+- Last version to support python 2
+
+pyrh 1.0.1 (2017-11-07)
+=======================
+- Added custom exception

docs/changelog.rst

@@ -0,0 +1,77 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# 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 sys
+from pathlib import Path
+
+
+# curr_file = Path(__file__).parent
+# sys.path.append(curr_file.joinpath("..").resolve())
+# sys.path.append(curr_file.joinpath("../..").resolve())
+
+
+def get_version():
+    import toml
+
+    toml_path = Path(__file__).parent.joinpath("..", "pyproject.toml")
+
+    with open(toml_path, "r") as file:
+        pyproject = toml.load(file)
+
+    return pyproject["tool"]["poetry"]["version"]
+
+
+# -- Project information -----------------------------------------------------
+
+project = "pyrh"
+copyright = "2020, Unofficial Robinhood Python API"
+author = "Unofficial Robinhood Python API"
+
+# The full version, including alpha/beta/rc tags
+release = get_version()
+
+
+# -- General configuration ---------------------------------------------------
+
+# 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.napoleon", "sphinx.ext.intersphinx"]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- 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 = "sphinx_rtd_theme"
+
+# 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"]
+
+# source_suffix = '.rst'
+source_suffix = [".rst"]
+
+# intersphinx
+intersphinx_mapping = {
+    "requests": ("https://requests.readthedocs.io/en/master/", None),
+}