update docs

Author: timkpaine

docs/api.rst

@@ -4,9 +4,8 @@ API
 .. toctree::
    :maxdepth: 4
 
-Client
-------
-.. autoclass:: pyEX.Client
+   client
+
 
 Alternative
 --------------------------------
@@ -16,8 +15,7 @@ Alternative
 
 Commodities
 --------------------------------
-.. automodule:: pyEX.commodities
-    :members:
+.. autoclass:: pyEX.commodities.CommoditiesPoints
     :noindex:
 
 Crypto
@@ -28,8 +26,7 @@ Crypto
 
 Economic
 --------------------------------
-.. automodule:: pyEX.economic
-    :members:
+.. autoclass:: pyEX.economic.EconomicPoints
     :noindex:
 
 FX
@@ -52,8 +49,7 @@ Points
 
 Rates
 --------------------------------
-.. automodule:: pyEX.rates
-    :members:
+.. autoclass:: pyEX.rates.RatesPoints
     :noindex:
 
 Reference Data

docs/client.rst

@@ -0,0 +1,9 @@
+Client
+====
+
+.. toctree::
+   :maxdepth: 4
+
+.. autoclass:: pyEX.Client
+    :noindex:
+    :members:

pyEX/client.py

@@ -112,6 +112,8 @@
     sar = None
     sma = None
 
+DEFAULT_API_LIMIT = 5
+
 _INCLUDE_FUNCTIONS = [
     # Refdata
     ('symbols', symbols),
@@ -371,7 +373,11 @@
     ('housing', EconomicPoints.HOUSING.value),
     ('unemployment', EconomicPoints.UNEMPLOYMENT.value),
     ('vehicles', EconomicPoints.VEHICLES.value),
-    ('recession_prob', EconomicPoints.RECESSION_PROB.value),
+    ('recessionProb', EconomicPoints.RECESSION_PROB.value),
+    ('initialClaims', EconomicPoints.INITIALCLAIMS.value),
+    ('institutionalMoney', EconomicPoints.INSTITUTIONALMONEY.value),
+    ('retailMoney', EconomicPoints.RETAILMONEY.value),
+
 ]
 
 _INCLUDE_STUDIES = [
@@ -395,16 +401,20 @@ class Client(object):
                           set version to 'sandbox' to run against the IEX sandbox
         api_limit (int): cache calls in this interval
     '''
+    _api_limit = DEFAULT_API_LIMIT
+
     def __init__(self,
                  api_token=None,
                  version='v1',
-                 api_limit=5):
+                 api_limit=DEFAULT_API_LIMIT):
         self._token = api_token or os.environ.get('IEX_TOKEN', '')
         if not self._token:
             raise PyEXception('API Token missing or not in environment (IEX_TOKEN)')
 
         self._version = version
         self._api_limit = api_limit
+
+        # rebind
         for name, method in _INCLUDE_FUNCTIONS:
             setattr(self, name, wraps(method)(partial(self.bind, meth=method)))
             getattr(self, name).__doc__ = method.__doc__
@@ -434,3 +444,20 @@ def usage(self, type=None):
                 raise PyEXception('type not recognized: {}'.format(type))
             return _getJson('account/usage/{type}'.format(type=type), self._token, self._version)
         return _getJson('account/usage/messages', self._token, self._version)
+
+
+#############################
+# for autodoc
+for name, method in _INCLUDE_FUNCTIONS:
+    setattr(Client, name, method)
+    getattr(Client, name).__doc__ = method.__doc__
+
+for name, key in _INCLUDE_POINTS:
+    p = partial(Client.bind, meth=points, key=key)
+    p.__name__ = key
+    setattr(Client, name, wraps(points)(p))
+    getattr(Client, name).__doc__ = points.__doc__
+
+for name, method in _INCLUDE_STUDIES:
+    if method:
+        setattr(Client, name, method)

pyEX/commodities.py

@@ -3,6 +3,22 @@
 
 
 class CommoditiesPoints(Enum):
+    '''Commodities data points
+
+    https://iexcloud.io/docs/api/#commodities
+
+    Attributes:
+        WTI; Crude oil West Texas Intermediate - in dollars per barrel, not seasonally adjusted
+        BRENT; Crude oil Brent Europe - in dollars per barrel, not seasonally adjusted
+        NATGAS; Henry Hub Natural Gas Spot Price - in dollars per million BTU, not seasonally adjusted
+        HEATOIL; No. 2 Heating Oil New York Harbor - in dollars per gallon, not seasonally adjusted
+        JET; Kerosense Type Jet Fuel US Gulf Coast - in dollars per gallon, not seasonally adjusted
+        DIESEL; US Diesel Sales Price - in dollars per gallon, not seasonally adjusted
+        GASREG; US Regular Conventional Gas Price - in dollars per gallon, not seasonally adjusted
+        GASMID; US Midgrade Conventional Gas Price - in dollars per gallon, not seasonally adjusted
+        GASPRM; US Premium Conventional Gas Price - in dollars per gallon, not seasonally adjusted
+        PROPANE; Propane Prices Mont Belvieu Texas - in dollars per gallon, not seasonally adjusted
+    '''
     WTI = 'DCOILWTICO'
     BRENT = 'DCOILBRENTEU'
     NATGAS = 'DHHNGSP'

pyEX/economic.py

@@ -3,6 +3,31 @@
 
 
 class EconomicPoints(Enum):
+    '''Economic data points
+
+    https://iexcloud.io/docs/api/#economic-data
+
+    Attributes:
+        US0; US 30-Year fixed rate mortgage average
+        US5; US 15-Year fixed rate mortgage average
+        US; US 5/1-Year adjustable rate mortgage average
+        FEDFUNDS; Effective federal funds rate
+        CREDITCARD; Commercial bank credit card interest rate as a percent, not seasonally adjusted
+        CDNJ; CD Rate Non-Jumbo less than $100,000 Money market
+        CDJ; CD Rate Jumbo more than $100,000 Money market
+        GDP; Real Gross Domestic Product
+        INDPRO; Industrial Production Index
+        CPI; Consumer Price Index All Urban Consumers
+        PAYROLL; Total nonfarm employees in thousands of persons seasonally adjusted
+        HOUSING; Total Housing Starts in thousands of units, seasonally adjusted annual rate
+        UNEMPLOYMENT; Unemployment rate returned as a percent, seasonally adjusted
+        VEHICLES; Total Vehicle Sales in millions of units
+        RECESSION; US Recession Probabilities. Smoothed recession probabilities for the United States are obtained from a dynamic-factor markov-switching model applied to four monthly coincident variables. non-farm payroll employment, the index of industrial production, real personal income excluding transfer payments, and real manufacturing and trade sales.
+        INITIALCLAIMS; Initial claims returned as a number, seasonally adjusted
+        RETAILMONEY; Retail money funds returned as billions of dollars, seasonally adjusted
+        INSTITUTIONALMONEY; Institutional money funds returned as billions of dollars, seasonally adjusted
+    '''
+
     US30 = 'MORTGAGE30US'
     US15 = 'MORTGAGE15US'
     US5 = 'MORTGAGE5US'
@@ -18,6 +43,9 @@ class EconomicPoints(Enum):
     UNEMPLOYMENT = 'UNRATE'
     VEHICLES = 'TOTALSA'
     RECESSION_PROB = 'RECPROUSM156N'
+    INITIALCLAIMS = 'IC4WSA'
+    RETAILMONEY = 'WRMFSL'
+    INSTITUTIONALMONEY = 'WIMFSL'
 
     @staticmethod
     @lru_cache(1)

pyEX/rates.py

@@ -3,6 +3,21 @@
 
 
 class RatesPoints(Enum):
+    '''Rates data points
+
+    https://iexcloud.io/docs/api/#treasuries
+
+    Attributes:
+        THIRTY; 30 Year constant maturity rate
+        TWENTY; 20 Year constant maturity rate
+        TEN; 10 Year constant maturity rate
+        FIVE; 5 Year constant maturity rate
+        TWO; 2 Year constant maturity rate
+        ONE; 1 Year constant maturity rate
+        SIXMONTH; 6 Month constant maturity rate
+        THREEMONTH; 3 Month constant maturity rate
+        ONEMONTH; 1 Month constant maturity rate
+    '''
     THIRTY = 'DGS30'
     TWENTY = 'DGS20'
     TEN = 'DGS10'

pyEX/tests/test_economic.py

@@ -22,4 +22,7 @@ def test_all(self):
             c.housing()
             c.unemployment()
             c.vehicles()
-            c.recession_prob()
+            c.recessionProb()
+            c.initialClaims()
+            c.institutionalMoney()
+            c.retailMoney()

setup.cfg

@@ -5,5 +5,5 @@ universal=1
 description_file = README.md
 
 [flake8]
-max-line-length=310
+max-line-length=400
 exclude=pyEX/tests/