Merge pull request #4 from vfrazao-ns1/develop/add-docs

Develop/add docs

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+Contributions welcome.
+
+Project direction is a bit unclear at the moment, so I would appreciate any feedback on potential use cases. Please file an issue or fork the repo to contribute.

IEXTools/IEX_API.py

@@ -1,19 +1,19 @@
 """
-This module defines the IEX_API class which acts as an abstraction to the IEX
+This module defines the IEXAPI class which acts as an abstraction to the IEX
 REST API.
 
-The IEX_API attempts to implement every endpoint available on the public API.
+The IEXAPI attempts to implement every endpoint available on the public API.
 
 All functions of this client that calls out to the IEX API must follow the same
 design pattern:
     1) Perform error checking on inputs given (e.g., if expecting certain
        arguments)
-    2) Retrieve the required endpoint by calling the _get_endpoint method
+    2) Retrieve the required endpoint by calling the `_get_endpoint` method
     3) Build the parameters to be used by the function
-    4) Route all calls to the IEX API through the _request method
+    4) Route all calls to the IEX API through the `_request` method
 
 Any new endpoints should subsequently be registered in the endpoints variable
-of the _get_endpoint method.
+of the `_get_endpoint` method.
 
 #TODO make async implementation of API client
 """

README.md

@@ -1,9 +1,11 @@
 # IEXTools
 
-v 0.0.3
+v 0.0.4
 
 This package provides tools for working with data provided by IEX's REST API and tools to decode and use IEX's binary market data (dubbed "HIST"). For more information on the type of data offered by IEX please visit their website: <https://iextrading.com/developer/docs> and <https://iextrading.com/trading/market-data/>
 
+Documentation for the module is hosted on readthedocs.io: <https://iextools.readthedocs.io/en/latest/>
+
 ## Disclaimers
 
 The author and contributors to this repository are not in any way associated with IEX. This code is provided AS IS with no warranties or any guarantees. It is entirely possible that at any moment this package will not work either due to a programming error or due to a change from IEX.
@@ -269,12 +271,11 @@ By not specifying the `allowed` argument the parser returns 1,000,000 parsed mes
 - `IEXAPI` class: allows the user to access all endpoints of the IEX REST API v1
 - Added tests for the `IEXAPI` class
 
-### Future Focus
+### 0.0.4
 
-- Need additional tests
-- Review typing functionality
+- Added documentation (via Sphinx)
 
-## Requirements
+### Future Focus
 
-- Python 3.7
-- requests
+- Additional testing
+- Review typing functionality

docs/Makefile

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

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+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/source/conf.py

@@ -0,0 +1,193 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- 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 os
+import sys
+sys.path.insert(0, os.path.abspath('../..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'IEXTools'
+copyright = '2018, Victor Frazao'
+author = 'Victor Frazao'
+
+# The short X.Y version
+version = '0.0.4'
+# The full version, including alpha/beta/rc tags
+release = '0.0.4'
+
+
+# -- 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.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+]
+
+# 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'
+
+# 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 pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- 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.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'IEXToolsdoc'
+
+
+# -- 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, 'IEXTools.tex', 'IEXTools Documentation',
+     'Victor Frazao', '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, 'iextools', 'IEXTools 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, 'IEXTools', 'IEXTools Documentation',
+     author, 'IEXTools', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True

docs/source/datadownloader.rst

@@ -0,0 +1,47 @@
+Data Downloader
+===============
+
+Usage
+-----
+
+Purpose: Download IEX's pcap files containing nanosecond precision stock data - the so called HIST files.
+
+The `DataDownloader` class can be instantiated without any arguments by simply calling the class.
+
+``d1 = IEXTools.DataDownloader()``
+
+There are three available methods in this class::
+
+   >>> print([method for method in dir(IEXTools.DataDownloader) if not method.startswith('_')])
+   
+   ['decompress', 'download', 'download_decompressed']
+
+- download: Downloads the gziped TOPS or DEEP file for a given datetime input
+- decompress: Unzips the compressed HIST file into a pcap
+- download_decompressed: downloads and decompresses the HIST file - deletes the zipped file at the end
+
+**Warning, IEX HIST files are generally very large (multiple gbs)**
+
+Usage::
+
+   >>> import IEXTools
+   >>> from datetime import datetime
+   >>> d1 = IEXTools.DataDownloader()
+   >>> d1.download_decompressed(datetime(2018, 7, 13), feed_type='tops')
+   '20180713_IEXTP1_TOPS1.6.pcap'
+
+Module Docs
+-----------
+
+.. automodule:: IEXTools.IEXDownloader
+   :members:
+
+.. autoclass:: DataDownloader
+    :members:
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`