Add TT JSON object representation (#34)

* add TypedDicts for TT JSON objects
* add typeddict docs
* small typing changes
* docs overhaul; use README in rtd and github

Author: Graeme22

README.md

@@ -0,0 +1,85 @@
+.. image:: https://readthedocs.org/projects/tastyworks-api/badge/?version=latest
+   :target: https://tastyworks-api.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
+
+.. image:: https://img.shields.io/pypi/v/tastytrade
+   :target: https://pypi.org/project/tastytrade
+   :alt: PyPI Package
+
+.. image:: https://static.pepy.tech/badge/tastytrade
+   :target: https://pepy.tech/project/tastytrade
+   :alt: PyPI Downloads
+
+Tastytrade Python SDK
+=====================
+
+.. inclusion-marker
+
+A simple, reverse-engineered SDK for Tastytrade built on their (mostly) public API. This will allow you to create trading algorithms for whatever strategies you may have quickly and painlessly in Python.
+
+Installation
+------------
+
+.. code-block:: bash
+
+   $ pip install tastytrade
+
+Creating a session
+------------------
+
+A session object is required to authenticate your requests to the Tastytrade API.
+You can create a real session using your normal login, or a certification (test) session using your certification login.
+
+.. code-block:: python
+
+   from tastytrade.session import Session
+   session = Session('username', 'password')
+
+Using the streamer
+------------------
+
+The streamer is a websocket connection to the Tastytrade API that allows you to subscribe to real-time data for Quotes, Greeks, and more.
+
+.. code-block:: python
+
+   from tastytrade.streamer import DataStreamer, EventType
+
+   streamer = await DataStreamer.create(session)
+   subs_list = ['SPY', 'SPX']
+
+   quotes = await streamer.oneshot(EventType.QUOTE, subs_list)
+   print(quotes)
+
+>>> [Quote(eventSymbol='SPY', eventTime=0, sequence=0, timeNanoPart=0, bidTime=0, bidExchangeCode='Q', bidPrice=411.58, bidSize=400.0, askTime=0, askExchangeCode='Q', askPrice=411.6, askSize=1313.0), Quote(eventSymbol='SPX', eventTime=0, sequence=0, timeNanoPart=0, bidTime=0, bidExchangeCode='\x00', bidPrice=4122.49, bidSize='NaN', askTime=0, askExchangeCode='\x00', askPrice=4123.65, askSize='NaN')]
+
+Getting current positions
+-------------------------
+
+.. code-block:: python
+   
+   from tastytrade.account import Account
+
+   account = Account.get_accounts(session)[0]
+   positions = account.get_positions(session)
+   print(positions[0])
+
+>>> {'account-number': '########', 'symbol': 'INTC', 'instrument-type': 'Equity', 'underlying-symbol': 'INTC', 'quantity': 1, 'quantity-direction': 'Long', 'close-price': '29.8', 'average-open-price': '29.2997', 'average-yearly-market-close-price': '29.2997', 'average-daily-market-close-price': '29.8', 'multiplier': 1, 'cost-effect': 'Credit', 'is-suppressed': False, 'is-frozen': False, 'restricted-quantity': 0, 'realized-day-gain': '0.015', 'realized-day-gain-effect': 'Debit', 'realized-day-gain-date': '2023-05-15', 'realized-today': '0.015', 'realized-today-effect': 'Debit', 'realized-today-date': '2023-05-15', 'created-at': '2023-05-15T15:38:38.124+00:00', 'updated-at': '2023-05-15T15:42:08.991+00:00'}
+
+Symbol search
+-------------
+
+.. code-block:: python
+
+   from tastytrade.search import symbol_search
+
+   results = symbol_search(session, 'AAP')
+   print(results)
+
+>>> [{'symbol': 'AAP', 'description': 'Advance Auto Parts Inc.'}, {'symbol': 'AAPL', 'description': 'Apple Inc. - Common Stock'}]
+
+For more documentation and examples, check out: <https://tastyworks-api.readthedocs.io/en/latest/>.
+
+Disclaimer
+----------
+
+This is an unofficial SDK for Tastytrade. There is no implied warranty for any actions and results which arise from using it.

README.rst

@@ -19,7 +19,8 @@
     "sphinx.ext.doctest",
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
-    "sphinx.ext.intersphinx"
+    "sphinx.ext.intersphinx",
+    "sphinx_toolbox.more_autodoc.autotypeddict"
 ]
 
 intersphinx_mapping = {

docs/conf.py

@@ -5,12 +5,12 @@ tastytrade: An unofficial Python SDK for Tastytrade!
    :maxdepth: 2
    :caption: Documentation:
 
-   install
-   getting-started
+.. include:: ../README.rst
+   :start-after: inclusion-marker
 
 .. toctree::
    :maxdepth: 2
-   :caption: API Reference:
+   :caption: SDK Reference:
 
    tastytrade
    dxfeed

docs/getting-started.rst

@@ -1,58 +1,3 @@
-#
-# This file is autogenerated by pip-compile with python 3.10
-# To update, run:
-#
-#    pip-compile requirements.in
-#
-alabaster==0.7.12
-    # via sphinx
-babel==2.10.3
-    # via sphinx
-certifi==2022.9.14
-    # via requests
-charset-normalizer==2.1.1
-    # via requests
-docutils==0.17.1
-    # via
-    #   sphinx
-    #   sphinx-rtd-theme
-idna==3.4
-    # via requests
-imagesize==1.4.1
-    # via sphinx
-jinja2==3.1.2
-    # via sphinx
-markupsafe==2.1.1
-    # via jinja2
-packaging==21.3
-    # via sphinx
-pygments==2.13.0
-    # via sphinx
-pyparsing==3.0.9
-    # via packaging
-pytz==2022.2.1
-    # via babel
-requests==2.28.1
-    # via sphinx
-snowballstemmer==2.2.0
-    # via sphinx
-sphinx==5.1.1
-    # via
-    #   -r requirements.in
-    #   sphinx-rtd-theme
-sphinx-rtd-theme==1.0.0
-    # via -r requirements.in
-sphinxcontrib-applehelp==1.0.2
-    # via sphinx
-sphinxcontrib-devhelp==1.0.2
-    # via sphinx
-sphinxcontrib-htmlhelp==2.0.0
-    # via sphinx
-sphinxcontrib-jsmath==1.0.1
-    # via sphinx
-sphinxcontrib-qthelp==1.0.3
-    # via sphinx
-sphinxcontrib-serializinghtml==1.1.5
-    # via sphinx
-urllib3==1.26.12
-    # via requests
+sphinx==5.3.0
+sphinx-rtd-theme==1.1.1
+sphinx-toolbox==3.4.0

docs/index.rst

@@ -8,6 +8,22 @@ Account
 .. autoclass:: Account
    :members:
 
+.. autotypeddict:: AccountBalance
+
+.. autotypeddict:: AccountBalanceSnapshot
+
+.. autotypeddict:: CurrentPosition
+
+.. autotypeddict:: MarginRequirement
+
+.. autotypeddict:: NetLiqOhlc
+
+.. autotypeddict:: PositionLimit
+
+.. autotypeddict:: Transaction
+
+.. autotypeddict:: TradingStatus
+
 Instruments
 -----------
 .. module:: tastytrade.instruments
@@ -46,12 +62,20 @@ Metrics
 
 .. autofunction:: get_earnings
 
+.. autotypeddict:: MarketMetricInfo
+
+.. autotypeddict:: DividendInfo
+
+.. autotypeddict:: EarningsInfo
+
 Search
 ------
 .. module:: tastytrade.search
 
 .. autofunction:: symbol_search
 
+.. autotypeddict:: SymbolData
+
 Session
 -------
 .. module:: tastytrade.session
@@ -85,6 +109,10 @@ Utils
 
 .. autofunction:: get_third_friday
 
+.. autofunction:: snakeify
+
+.. autofunction:: desnakeify
+
 Watchlists
 ----------
 

docs/install.rst

@@ -4,7 +4,5 @@ requests==2.26.0
 mypy==0.931
 flake8==3.9.2
 isort==5.8.0
-sphinx==5.3.0
-sphinx_rtd_theme==1.0.0
 types-requests==2.28.10
 websockets==11.0.3

docs/requirements.txt

@@ -18,10 +18,10 @@
     url='https://github.com/tastyware/tastytrade',
     license='Apache',
     install_requires=[
-        'aiohttp<4',
         'requests<3',
         'tastyworks-aiocometd>=1.0',
-        'dataclasses'
+        'dataclasses',
+        'websockets>=11.0.3'
     ],
     packages=find_packages(exclude=['ez_setup', 'tests*']),
     include_package_data=True,