docs refresh, pypi rst fix

Author: Graeme22

docs/conf.py

@@ -48,3 +48,5 @@
 autodoc_pydantic_settings_show_json = False
 autodoc_pydantic_show_field_summary = True
 autodoc_pydantic_model_undoc_members = False
+autodoc_pydantic_model_hide_paramlist = False
+

docs/dxfeed.rst

@@ -10,65 +10,54 @@ If you want to double-check you typed the symbol right, or want to troubleshoot
 Event
 -----
 
-.. module:: tastytrade.dxfeed.event
-
-.. autoenum:: EventType
-
-.. autoclass:: Event
+.. automodule:: tastytrade.dxfeed.event
    :members:
 
 Candle
 ------
 
-.. module:: tastytrade.dxfeed.candle
-
-.. autoclass:: Candle
+.. automodule:: tastytrade.dxfeed.candle
    :members:
+   :show-inheritance:
 
 Greeks
 ------
 
-.. module:: tastytrade.dxfeed.greeks
-
-.. autoclass:: Greeks
+.. automodule:: tastytrade.dxfeed.greeks
    :members:
+   :show-inheritance:
 
 Profile
 -------
 
-.. module:: tastytrade.dxfeed.profile
-
-.. autoclass:: Profile
+.. automodule:: tastytrade.dxfeed.profile
    :members:
+   :show-inheritance:
 
 Quote
 -----
 
-.. module:: tastytrade.dxfeed.quote
-
-.. autoclass:: Quote
+.. automodule:: tastytrade.dxfeed.quote
    :members:
+   :show-inheritance:
 
 Summary
 -------
 
-.. module:: tastytrade.dxfeed.summary
-
-.. autoclass:: Summary
+.. automodule:: tastytrade.dxfeed.summary
    :members:
+   :show-inheritance:
 
 TheoPrice
 ---------
 
-.. module:: tastytrade.dxfeed.theoprice
-
-.. autoclass:: TheoPrice
+.. automodule:: tastytrade.dxfeed.theoprice
    :members:
+   :show-inheritance:
 
 Trade
 -----
 
-.. module:: tastytrade.dxfeed.trade
-
-.. autoclass:: Trade
+.. automodule:: tastytrade.dxfeed.trade
    :members:
+   :show-inheritance:

docs/tastytrade.rst

@@ -5,43 +5,52 @@ Account
 -------
 .. automodule:: tastytrade.account
    :members:
+   :show-inheritance:
 
 Instruments
 -----------
 .. automodule:: tastytrade.instruments
    :members:
+   :show-inheritance:
 
 Metrics
 -------
 .. automodule:: tastytrade.metrics
    :members:
+   :show-inheritance:
 
 Order
 -----
 .. automodule:: tastytrade.order
    :members:
+   :show-inheritance:
 
 Search
 ------
 .. automodule:: tastytrade.search
    :members:
+   :show-inheritance:
 
 Session
 -------
 .. automodule:: tastytrade.session
    :members:
+   :show-inheritance:
 
 Streamer
 --------
 .. automodule:: tastytrade.streamer
    :members:
+   :show-inheritance:
 
 Utils
 -----
 .. automodule:: tastytrade.utils
    :members:
+   :inherited-members:
 
 Watchlists
 ----------
 .. automodule:: tastytrade.watchlists
    :members:
+   :show-inheritance:

setup.py

@@ -12,17 +12,17 @@
     version=VERSION,
     description='An unofficial SDK for Tastytrade!',
     long_description=LONG_DESCRIPTION,
-    long_description_content_type='text/markdown',
+    long_description_content_type='text/x-rst',
     author='Graeme Holliday',
     author_email='graeme.holliday@pm.me',
     url='https://github.com/tastyware/tastytrade',
-    license='Apache',
+    license='MIT',
     install_requires=[
         'requests<3',
         'dataclasses',
         'websockets>=11.0.3',
         'pydantic>=1.10.7'
     ],
     packages=find_packages(exclude=['ez_setup', 'tests*']),
-    include_package_data=True,
+    include_package_data=True
 )

tastytrade/__init__.py

@@ -2,7 +2,7 @@
 
 API_URL = 'https://api.tastyworks.com'
 CERT_URL = 'https://api.cert.tastyworks.com'
-VERSION = '5.0'
+VERSION = '5.1'
 
 
 logger = logging.getLogger(__name__)

tastytrade/utils.py

@@ -34,7 +34,7 @@ def validate_response(response: Response) -> None:
     """
     Checks if the given code is an error; if so, raises an exception.
 
-    :param json: response to check for errors
+    :param response: response to check for errors
     """
     if response.status_code // 100 != 2:
         content = response.json()['error']