From accb04c33270e54950e1819daba52441e143ad18 Mon Sep 17 00:00:00 2001 From: Darcy Linde <{47221647+Darcy-Linde@users.noreply.github.com}> Date: Thu, 5 May 2022 10:22:16 -0400 Subject: [PATCH 1/7] changed shared to common --- polygon/rest/models/__init__.py | 2 +- polygon/rest/models/{shared.py => common.py} | 0 polygon/rest/models/conditions.py | 2 +- polygon/rest/models/dividends.py | 2 +- polygon/rest/models/exchanges.py | 2 +- polygon/rest/models/tickers.py | 2 +- 6 files changed, 5 insertions(+), 5 deletions(-) rename polygon/rest/models/{shared.py => common.py} (100%) diff --git a/polygon/rest/models/__init__.py b/polygon/rest/models/__init__.py index d6edfd09..ce0103be 100644 --- a/polygon/rest/models/__init__.py +++ b/polygon/rest/models/__init__.py @@ -1,4 +1,4 @@ -from .shared import * +from .common import * from .aggs import * from .trades import * from .quotes import * diff --git a/polygon/rest/models/shared.py b/polygon/rest/models/common.py similarity index 100% rename from polygon/rest/models/shared.py rename to polygon/rest/models/common.py diff --git a/polygon/rest/models/conditions.py b/polygon/rest/models/conditions.py index d1cb2801..32a268d0 100644 --- a/polygon/rest/models/conditions.py +++ b/polygon/rest/models/conditions.py @@ -1,5 +1,5 @@ from typing import Optional -from .shared import AssetClass, DataType +from .common import AssetClass, DataType from dataclasses import dataclass diff --git a/polygon/rest/models/dividends.py b/polygon/rest/models/dividends.py index f70adf9f..014e5d4d 100644 --- a/polygon/rest/models/dividends.py +++ b/polygon/rest/models/dividends.py @@ -1,5 +1,5 @@ from typing import Optional -from .shared import DividendType, Frequency +from .common import DividendType, Frequency from dataclasses import dataclass diff --git a/polygon/rest/models/exchanges.py b/polygon/rest/models/exchanges.py index 64527710..1cd0e07d 100644 --- a/polygon/rest/models/exchanges.py +++ b/polygon/rest/models/exchanges.py @@ -1,5 +1,5 @@ from typing import Optional -from .shared import AssetClass, Locale, ExchangeType +from .common import AssetClass, Locale, ExchangeType from dataclasses import dataclass diff --git a/polygon/rest/models/tickers.py b/polygon/rest/models/tickers.py index f0b52e48..767fe5ca 100644 --- a/polygon/rest/models/tickers.py +++ b/polygon/rest/models/tickers.py @@ -1,5 +1,5 @@ from typing import Optional, List -from .shared import Locale, Market, AssetClass +from .common import Locale, Market, AssetClass from dataclasses import dataclass From 2c46c898d9e8b32fabe5bc8515261e5042c32663 Mon Sep 17 00:00:00 2001 From: Darcy Linde <{47221647+Darcy-Linde@users.noreply.github.com}> Date: Thu, 5 May 2022 10:24:56 -0400 Subject: [PATCH 2/7] add common.rst --- docs/source/Common.rst | 0 docs/source/index.rst | 1 + 2 files changed, 1 insertion(+) create mode 100644 docs/source/Common.rst diff --git a/docs/source/Common.rst b/docs/source/Common.rst new file mode 100644 index 00000000..e69de29b diff --git a/docs/source/index.rst b/docs/source/index.rst index 35a50003..2ec2a745 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -16,6 +16,7 @@ This documentation is for the Python client only. For details about the response Trades vX Models + Common Indices and tables From c7657da5a4ee9f9507dc6dbfd658b5dec6ba4c83 Mon Sep 17 00:00:00 2001 From: Darcy Linde <{47221647+Darcy-Linde@users.noreply.github.com}> Date: Thu, 5 May 2022 10:28:36 -0400 Subject: [PATCH 3/7] remove common.rst --- docs/source/Common.rst | 0 docs/source/index.rst | 1 - 2 files changed, 1 deletion(-) delete mode 100644 docs/source/Common.rst diff --git a/docs/source/Common.rst b/docs/source/Common.rst deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/source/index.rst b/docs/source/index.rst index 2ec2a745..35a50003 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -16,7 +16,6 @@ This documentation is for the Python client only. For details about the response Trades vX Models - Common Indices and tables From d9b772e376bba2bfae4a5a5aa121e25bdce290d9 Mon Sep 17 00:00:00 2001 From: Darcy Linde <{47221647+Darcy-Linde@users.noreply.github.com}> Date: Thu, 5 May 2022 10:49:48 -0400 Subject: [PATCH 4/7] enum.rst --- docs/source/Enums.rst | 67 ++++++++++++++++++++++++++++++++++++++++++ docs/source/Models.rst | 3 -- docs/source/index.rst | 1 + 3 files changed, 68 insertions(+), 3 deletions(-) create mode 100644 docs/source/Enums.rst diff --git a/docs/source/Enums.rst b/docs/source/Enums.rst new file mode 100644 index 00000000..3ad2b75a --- /dev/null +++ b/docs/source/Enums.rst @@ -0,0 +1,67 @@ +============================================================== +Sort +============================================================== +.. autoclass:: polygon.rest.models.Sort + :members: + :undoc-members: + +============================================================== +Order +============================================================== +.. autoclass:: polygon.rest.models.Order + +============================================================== +Locale +============================================================== +.. autoclass:: polygon.rest.models.Locale + +============================================================== +Market +============================================================== +.. autoclass:: polygon.rest.models.Market + +============================================================== +AssetClass +============================================================== +.. autoclass:: polygon.rest.models.AssetClass + +============================================================== +DividendType +============================================================== +.. autoclass:: polygon.rest.models.DividendType + +============================================================== +Frequency +============================================================== +.. autoclass:: polygon.rest.models.Frequency + +============================================================== +DataType +============================================================== +.. autoclass:: polygon.rest.models.DataType + +============================================================== +SIP +============================================================== +.. autoclass:: polygon.rest.models.SIP + +============================================================== +ExchangeType +============================================================== +.. autoclass:: polygon.rest.models.ExchangeType + +============================================================== +Direction +============================================================== +.. autoclass:: polygon.rest.models.Direction + +============================================================== +SnapshotMarketType +============================================================== +.. autoclass:: polygon.rest.models.SnapshotMarketType + +============================================================== +Timeframe +============================================================== +.. autoclass:: polygon.rest.models.Timeframe + diff --git a/docs/source/Models.rst b/docs/source/Models.rst index c003b4c9..05dcb437 100644 --- a/docs/source/Models.rst +++ b/docs/source/Models.rst @@ -192,6 +192,3 @@ Condition Exchange ============================================================== .. autoclass:: polygon.rest.models.Exchange - - - diff --git a/docs/source/index.rst b/docs/source/index.rst index 35a50003..dab96872 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -16,6 +16,7 @@ This documentation is for the Python client only. For details about the response Trades vX Models + Enums Indices and tables From 2001aa8277c7e88c776fa2d9aa0987314af42517 Mon Sep 17 00:00:00 2001 From: Darcy Linde <{47221647+Darcy-Linde@users.noreply.github.com}> Date: Thu, 5 May 2022 10:52:27 -0400 Subject: [PATCH 5/7] sphinx doc commands --- docs/source/Enums.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/source/Enums.rst b/docs/source/Enums.rst index 3ad2b75a..5efd76d4 100644 --- a/docs/source/Enums.rst +++ b/docs/source/Enums.rst @@ -9,11 +9,15 @@ Sort Order ============================================================== .. autoclass:: polygon.rest.models.Order + :members: + :undoc-members: ============================================================== Locale ============================================================== .. autoclass:: polygon.rest.models.Locale + :members: + :undoc-members: ============================================================== Market @@ -24,44 +28,62 @@ Market AssetClass ============================================================== .. autoclass:: polygon.rest.models.AssetClass + :members: + :undoc-members: ============================================================== DividendType ============================================================== .. autoclass:: polygon.rest.models.DividendType + :members: + :undoc-members: ============================================================== Frequency ============================================================== .. autoclass:: polygon.rest.models.Frequency + :members: + :undoc-members: ============================================================== DataType ============================================================== .. autoclass:: polygon.rest.models.DataType + :members: + :undoc-members: ============================================================== SIP ============================================================== .. autoclass:: polygon.rest.models.SIP + :members: + :undoc-members: ============================================================== ExchangeType ============================================================== .. autoclass:: polygon.rest.models.ExchangeType + :members: + :undoc-members: ============================================================== Direction ============================================================== .. autoclass:: polygon.rest.models.Direction + :members: + :undoc-members: ============================================================== SnapshotMarketType ============================================================== .. autoclass:: polygon.rest.models.SnapshotMarketType + :members: + :undoc-members: ============================================================== Timeframe ============================================================== .. autoclass:: polygon.rest.models.Timeframe + :members: + :undoc-members: From c11d0cb1ab02d548c39d05ad2bbcc42591ba6750 Mon Sep 17 00:00:00 2001 From: Darcy Linde <{47221647+Darcy-Linde@users.noreply.github.com}> Date: Thu, 5 May 2022 10:55:02 -0400 Subject: [PATCH 6/7] add header to enum.rst --- docs/source/Enums.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/source/Enums.rst b/docs/source/Enums.rst index 5efd76d4..a11f65a4 100644 --- a/docs/source/Enums.rst +++ b/docs/source/Enums.rst @@ -1,3 +1,8 @@ +.. _enums_header: + +Enums +============================================================== + ============================================================== Sort ============================================================== From f41db891b01ecc7ed715c92412bfdc3a904dd964 Mon Sep 17 00:00:00 2001 From: Darcy Linde <{47221647+Darcy-Linde@users.noreply.github.com}> Date: Thu, 5 May 2022 10:58:24 -0400 Subject: [PATCH 7/7] add missing members call --- docs/source/Enums.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/Enums.rst b/docs/source/Enums.rst index a11f65a4..f59e077f 100644 --- a/docs/source/Enums.rst +++ b/docs/source/Enums.rst @@ -28,6 +28,8 @@ Locale Market ============================================================== .. autoclass:: polygon.rest.models.Market + :members: + :undoc-members: ============================================================== AssetClass