address most of caleb feedback (#169)

* address most of caleb feedback

* beta

* fix financials models and test

* backlink for aggs

Author: clickingbuttons

README.md

@@ -7,7 +7,7 @@ Python client for the [Polygon.io API](https://polygon.io).
 
 ## Install
 
-`pip install polygon-api-client`
+`pip install polygon-api-client~=1.0.0b`
 
 Requires Python >= 3.7.
 

docs/source/Aggs.rst

@@ -6,6 +6,12 @@ Aggs
 ===========
 Get aggs
 ===========
+
+- `Stock aggs`_
+- `Options aggs`_
+- `Forex aggs`_
+- `Crypto aggs`_
+
 .. automethod:: polygon.RESTClient.get_aggs
 
 ============================
@@ -23,3 +29,7 @@ Get previous close agg
 ============================
 .. automethod:: polygon.RESTClient.get_previous_close_agg
 
+.. _Stock aggs: https://polygon.io/docs/stocks/get_v2_aggs_ticker__stocksticker__range__multiplier___timespan___from___to
+.. _Options aggs: https://polygon.io/docs/options/get_v2_aggs_ticker__optionsticker__range__multiplier___timespan___from___to
+.. _Forex aggs: https://polygon.io/docs/forex/get_v2_aggs_ticker__forexticker__range__multiplier___timespan___from___to
+.. _Crypto aggs: https://polygon.io/docs/crypto/get_v2_aggs_ticker__cryptoticker__range__multiplier___timespan___from___to

docs/source/Getting-Started.rst

@@ -8,7 +8,7 @@ Requirements:
 
 .. code-block:: shell
 
-    pip install polygon-api-client
+    pip install polygon-api-client~=1.0.0b
 
 HTTP client usage
 -----------------
@@ -45,7 +45,7 @@ For endpoints that have a set of parameters you can use the provided :doc:`enums
 
   client.list_trades(..., sort=Sort.ASC)
 
-To handle the raw `urllib3 response <https://urllib3.readthedocs.io/en/stable/reference/urllib3.response.html?highlight=response#response) yourself, pass `raw=True>`_ yourself pass :code:`raw=True`:
+To handle the raw `urllib3 response <https://urllib3.readthedocs.io/en/stable/reference/urllib3.response.html?highlight=response#response>`_ yourself pass :code:`raw=True`:
 
 .. literalinclude:: ../../examples/rest/raw-get.py
 
@@ -76,7 +76,7 @@ yourself (including unsubscribing and subscribing) you can use asyncio and the
 
 .. literalinclude:: ../../examples/websocket/async.py
 
-To handle raw messages yourself pass `raw=True`:
+To handle raw string or byte messages yourself pass :code:`raw=True`:
 
 .. literalinclude:: ../../examples/websocket/raw.py
 

polygon/rest/__init__.py

@@ -10,7 +10,7 @@
     ConditionsClient,
     ExchangesClient,
 )
-from .vx import VXClient
+from .vX import VXClient
 from typing import Optional
 import os
 
@@ -50,7 +50,7 @@ def __init__(
             base=base,
             verbose=verbose,
         )
-        self.vx = VXClient(
+        self.vX = VXClient(
             api_key=api_key,
             connect_timeout=connect_timeout,
             read_timeout=read_timeout,

polygon/rest/models/financials.py

@@ -9,7 +9,7 @@ class DataPoint:
     label: Optional[str] = None
     order: Optional[int] = None
     unit: Optional[str] = None
-    value: Optional[int] = None
+    value: Optional[float] = None
     xpath: Optional[str] = None
 
     @staticmethod
@@ -24,7 +24,7 @@ class ExchangeGainsLosses:
     label: Optional[str] = None
     order: Optional[int] = None
     unit: Optional[str] = None
-    value: Optional[int] = None
+    value: Optional[float] = None
     xpath: Optional[str] = None
 
     @staticmethod
@@ -39,7 +39,7 @@ class NetCashFlow:
     label: Optional[str] = None
     order: Optional[int] = None
     unit: Optional[str] = None
-    value: Optional[int] = None
+    value: Optional[float] = None
     xpath: Optional[str] = None
 
     @staticmethod
@@ -54,7 +54,7 @@ class NetCashFlowFromFinancingActivities:
     label: Optional[str] = None
     order: Optional[int] = None
     unit: Optional[str] = None
-    value: Optional[int] = None
+    value: Optional[float] = None
     xpath: Optional[str] = None
 
     @staticmethod
@@ -76,17 +76,15 @@ def from_dict(d):
         return CashFlowStatement(
             exchange_gains_losses=None
             if "exchange_gains_losses" not in d
-            else [ExchangeGainsLosses.from_dict(d["exchange_gains_losses"])],
+            else ExchangeGainsLosses.from_dict(d["exchange_gains_losses"]),
             net_cash_flow=None
             if "net_cash_flow" not in d
-            else [NetCashFlow.from_dict(d["net_cash_flow"])],
+            else NetCashFlow.from_dict(d["net_cash_flow"]),
             net_cash_flow_from_financing_activities=None
             if "net_cash_flow_from_financing_activities" not in d
-            else [
-                NetCashFlowFromFinancingActivities.from_dict(
-                    d["net_cash_flow_from_financing_activities"]
-                )
-            ],
+            else NetCashFlowFromFinancingActivities.from_dict(
+                d["net_cash_flow_from_financing_activities"]
+            ),
         )
 
 
@@ -97,7 +95,7 @@ class ComprehensiveIncomeLoss:
     label: Optional[str] = None
     order: Optional[int] = None
     unit: Optional[str] = None
-    value: Optional[int] = None
+    value: Optional[float] = None
     xpath: Optional[str] = None
 
     @staticmethod
@@ -112,7 +110,7 @@ class ComprehensiveIncomeLossAttributableToParent:
     label: Optional[str] = None
     order: Optional[int] = None
     unit: Optional[str] = None
-    value: Optional[int] = None
+    value: Optional[float] = None
     xpath: Optional[str] = None
 
     @staticmethod
@@ -127,7 +125,7 @@ class OtherComprehensiveIncomeLoss:
     label: Optional[str] = None
     order: Optional[int] = None
     unit: Optional[str] = None
-    value: Optional[int] = None
+    value: Optional[float] = None
     xpath: Optional[str] = None
 
     @staticmethod
@@ -149,21 +147,17 @@ def from_dict(d):
         return ComprehensiveIncome(
             comprehensive_income_loss=None
             if "comprehensive_income_loss" not in d
-            else [ComprehensiveIncomeLoss.from_dict(d["comprehensive_income_loss"])],
+            else ComprehensiveIncomeLoss.from_dict(d["comprehensive_income_loss"]),
             comprehensive_income_loss_attributable_to_parent=None
             if "comprehensive_income_loss_attributable_to_parent" not in d
-            else [
-                ComprehensiveIncomeLossAttributableToParent.from_dict(
-                    d["comprehensive_income_loss_attributable_to_parent"]
-                )
-            ],
+            else ComprehensiveIncomeLossAttributableToParent.from_dict(
+                d["comprehensive_income_loss_attributable_to_parent"]
+            ),
             other_comprehensive_income_loss=None
             if "other_comprehensive_income_loss" not in d
-            else [
-                OtherComprehensiveIncomeLoss.from_dict(
-                    d["other_comprehensive_income_loss"]
-                )
-            ],
+            else OtherComprehensiveIncomeLoss.from_dict(
+                d["other_comprehensive_income_loss"]
+            ),
         )
 
 
@@ -174,7 +168,7 @@ class BasicEarningsPerShare:
     label: Optional[str] = None
     order: Optional[int] = None
     unit: Optional[str] = None
-    value: Optional[int] = None
+    value: Optional[float] = None
     xpath: Optional[str] = None
 
     @staticmethod
@@ -189,7 +183,7 @@ class CostOfRevenue:
     label: Optional[str] = None
     order: Optional[int] = None
     unit: Optional[str] = None
-    value: Optional[int] = None
+    value: Optional[float] = None
     xpath: Optional[str] = None
 
     @staticmethod
@@ -204,7 +198,7 @@ class GrossProfit:
     label: Optional[str] = None
     order: Optional[int] = None
     unit: Optional[str] = None
-    value: Optional[int] = None
+    value: Optional[float] = None
     xpath: Optional[str] = None
 
     @staticmethod
@@ -219,7 +213,7 @@ class OperatingExpenses:
     label: Optional[str] = None
     order: Optional[int] = None
     unit: Optional[str] = None
-    value: Optional[int] = None
+    value: Optional[float] = None
     xpath: Optional[str] = None
 
     @staticmethod
@@ -234,7 +228,7 @@ class Revenues:
     label: Optional[str] = None
     order: Optional[int] = None
     unit: Optional[str] = None
-    value: Optional[int] = None
+    value: Optional[float] = None
     xpath: Optional[str] = None
 
     @staticmethod
@@ -256,19 +250,17 @@ def from_dict(d):
         return IncomeStatement(
             basic_earnings_per_share=None
             if "basic_earnings_per_share" not in d
-            else [BasicEarningsPerShare.from_dict(d["basic_earnings_per_share"])],
+            else BasicEarningsPerShare.from_dict(d["basic_earnings_per_share"]),
             cost_of_revenue=None
             if "cost_of_revenue" not in d
-            else [CostOfRevenue.from_dict(d["cost_of_revenue"])],
+            else CostOfRevenue.from_dict(d["cost_of_revenue"]),
             gross_profit=None
             if "gross_profit" not in d
-            else [GrossProfit.from_dict(d["gross_profit"])],
+            else GrossProfit.from_dict(d["gross_profit"]),
             operating_expenses=None
             if "operating_expenses" not in d
-            else [OperatingExpenses.from_dict(d["operating_expenses"])],
-            revenues=None
-            if "revenues" not in d
-            else [Revenues.from_dict(d["revenues"])],
+            else OperatingExpenses.from_dict(d["operating_expenses"]),
+            revenues=None if "revenues" not in d else Revenues.from_dict(d["revenues"]),
         )
 
 
@@ -288,13 +280,13 @@ def from_dict(d):
             else {k: DataPoint.from_dict(v) for (k, v) in d["balance_sheet"].items()},
             cash_flow_statement=None
             if "cash_flow_statement" not in d
-            else [CashFlowStatement.from_dict(d["cash_flow_statement"])],
+            else CashFlowStatement.from_dict(d["cash_flow_statement"]),
             comprehensive_income=None
             if "comprehensive_income" not in d
-            else [ComprehensiveIncome.from_dict(d["comprehensive_income"])],
+            else ComprehensiveIncome.from_dict(d["comprehensive_income"]),
             income_statement=None
             if "income_statement" not in d
-            else [IncomeStatement.from_dict(d["income_statement"])],
+            else IncomeStatement.from_dict(d["income_statement"]),
         )
 
 
@@ -321,7 +313,7 @@ def from_dict(d):
             filing_date=d.get("filing_date", None),
             financials=None
             if "financials" not in d
-            else [Financials.from_dict(d["financials"])],
+            else Financials.from_dict(d["financials"]),
             fiscal_period=d.get("fiscal_period", None),
             fiscal_year=d.get("fiscal_year", None),
             source_filing_file_url=d.get("source_filing_file_url", None),

polygon/rest/vx.py polygon/rest/vX.pypolygon/rest/vx.py renamed to polygon/rest/vX.py

@@ -24,7 +24,7 @@ def __init__(
         market: Union[str, Market] = Market.Stocks,
         raw: bool = False,
         verbose: bool = False,
-        subscriptions: List[str] = [],
+        subscriptions: Optional[List[str]] = None,
         max_reconnects: Optional[int] = 5,
         secure: bool = True,
         **kwargs,
@@ -33,8 +33,8 @@ def __init__(
         Initialize a Polygon WebSocketClient.
 
         :param api_key: Your API keYour API key.
-        :param feed: The feed to subscribe to (default RealTime)
-        :param raw: The market to subscribe to (default Stocks)
+        :param feed: The feed to subscribe to.
+        :param raw: Whether to pass raw Union[str, bytes] to user callback.
         :param verbose: Whether to print client and server status messages.
         :param subscriptions: List of subscription parameters.
         :param max_reconnects: How many times to reconnect on network outage before ending .connect event loop.
@@ -59,6 +59,8 @@ def __init__(
         self.subs: Set[str] = set()
         self.max_reconnects = max_reconnects
         self.websocket: Optional[WebSocketClientProtocol] = None
+        if subscriptions is None:
+            subscriptions = []
         self.scheduled_subs = set(subscriptions)
         self.schedule_resub = True