Merge remote-tracking branch 'origin/master' into pypi

.travis.yml

@@ -1,16 +1,45 @@
+sudo: false
+
 language: python
-python:
-  - "3.6"
-#  - "3.7" Will not include 3.7 support for now
-# earlier versions not supported by black
-# command to install dependencies
-# Current workaround for running Python 3.7 tests
-# sudo: required
-# dist: xenial
+
+matrix: 
+  include:
+    - python: 3.5
+      dist: trusty
+    - python: 3.6
+      dist: trusty
+      env: DOCBUILD=true
+    - python: 3.7
+      dist: xenial
+      sudo: true
+
+env:
+      global:
+        # Doctr deploy key for jackmoody11/stockscore
+        - secure: "MgSSDvTut3VcakoiK39VneLt0cBVhifnrKaFFu8XiLR9WW2qU/83aYPMV2zw8yM0XyU3IECFnAJWKCRr1bQGlhUS66Xlb/9zp5Yec1kVcU8GBY21r2k9YnkuFPYrgmdHrm5ChajQNJZ/nN8xgBstTIDdBIwtDn5rh3igcnHaAnm4BeEDlVnYqMsCa5VD0DlCPXZvDeqxjokMlb5NEn0La48k/oShYc+sa6gFfgUaLmPnE8b9EC0M4W2qq0jD4XmbGFyasN0LbSGs9vIOXooQybSTDyfEzGSySdRbU6mJO3rfVHL95Ewn0Sc6DRe0JVx11KKa0AXnUKXYD3u4HJ9tXn2KuWDmKPgSfMcjO6yKSR8vecvsdHXxcZszGw9mLFrw0dDKVDUWVOFiSkGMf8ukv3O6+LGo4ZDOV/+a9Bu4HGVdbAulQBmmAuuIVQN2cLf12WcHpd8oiEanuCqpNLr/MnqiokBCab9jGOtxB1Dj6qvhsW/PxQj01kWcbLF6Rr9dxh2zCsrsMVLV+fsQekhsup377gKNztPSGv6/qQJUn4S0rXQYtt3E7eYGzR/uDmhyHQQa4ZYSA6b4JQ6/X0R2WiB6wWdf7cOAeBeQ1/f5LsDRgsp2cI9dXydnv/9aKUVz1ZTgTFKiLxQqSqs5SG1GuOwqd1obU/oQtO2RwJE6oAg="
+
 install:
+  - pip install -qq flake8
+  - if [[ $DOCBUILD ]]; then
+      pip install doctr sphinx sphinx_rtd_theme ipython matplotlib;
+    fi
   - pip install -r requirements.txt
+
 script:
-  - pytest tests --runslow # or py.test for Python versions 3.5 and below
-os:
-  - linux
-# may add osx later if it works - currently having issues
+  - flake8 --version
+  - flake8 stockscore
+  - pytest stockscore/tests --runslow # or py.test for Python versions 3.5 and below
+
+after_success:
+  - |
+    if [[ $DOCBUILD ]]; then
+      cd docs
+      make html && make html
+      cd ..
+      doctr deploy devel --build-tags
+      if [[ -z ${TRAVIS_TAG} ]]; then
+        echo "Not a tagged build."
+      else
+        doctr deploy stable --build-tags
+      fi
+    fi

docs/source/conf.py

@@ -10,9 +10,10 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('../..'))
 
 
 # -- Project information -----------------------------------------------------
@@ -34,7 +35,7 @@
 # ones.
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.githubpages', 'sphinx.ext.todo',
               'IPython.sphinxext.ipython_console_highlighting', 'IPython.sphinxext.ipython_directive',
-              'sphinxcontrib.napoleon', ]
+              'sphinx.ext.napoleon', ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = []

docs/source/install.rst

@@ -9,7 +9,11 @@ Dependencies
 
 stockscore relies on:
 
-\# Need to update!!!
+- grequests
+- iexfinance
+- matplotlib
+- pandas
+- requests
 
 Installation
 ------------
@@ -30,18 +34,17 @@ or
 
 .. code:: bash
 
-     $ git clone https://github.com/jackmoody11/stockscore.git
-     $ cd stockscore
-     $ pip install .
+    $ git clone https://github.com/jackmoody11/stockscore.git
+    $ cd stockscore
+    $ pip install .
 
 **Note:**
 
-The use of
-`virtualenv <http://docs.python-guide.org/en/latest/dev/virtualenvs/>`__
-is recommended as below:
+The use of virtual environments is recommended as below. 
+Using `virtualenv` may cause problems due to a `known conflict<https://matplotlib.org/faq/virtualenv_faq.html>`__ 
+with `matplotlib`.
 
 .. code:: bash
 
-    $ pip install virtualenv
-    $ virtualenv env
-    $ source env/bin/activate
+    $ python3 -m venv myenv
+    $ source myvenv/bin/activate

docs/source/screens.rst

@@ -1,107 +1,101 @@
 .. _screens:
 
+
+.. currentmodule:: stockscore
+
 stockscore Screens
 ==================
 
 The `stockscore` module relies on many different screens. Screens relate to certain 
-"scores." Each stock is given scores based on relevant statistics. The available score 
+"scores." The `Scores` object takes one or more ticker symbols.
+
+.. autoclass:: stockscore.scores.Scores
+
+Each stock is given scores based on relevant statistics. The available score 
 categories are:
- * Value
- * Growth
- * Momentum
+
+* :ref:`Value<screens.value>`
+* :ref:`Growth<screens.growth>`
+* :ref:`Momentum<screens.momentum>`
+
+.. _screens.value:
 
 Value
 ~~~~~
-* :ref:`Trading Volume<scores.trading_volume_screen>`
-* :ref:`Net Income<scores.net_income_screen>`
-* :ref:`Current Ratio<scores.current_ratio_screen>`
-* :ref:`Price/Book Ratio<scores.p_to_b_screen>`
-* :ref:`Price/Earnings Ratio<scores.p_to_e_screen>`
-* :ref:`Profit Margin<scores.profit_margin_screen>`
-* :ref:`Dividend<scores.dividend_screen>`
+- :ref:`Trading Volume <screens.trading_volume_screen>`
+- :ref:`Net Income <screens.net_income_screen>`
+- :ref:`Current Ratio <screens.current_ratio_screen>`
+- :ref:`Price/Book Ratio <screens.pb_ratio_screen>`
+- :ref:`Price/Earnings Ratio <screens.pe_ratio_screen>`
+- :ref:`Profit Margin <screens.profit_margin_screen>`
+- :ref:`Dividend <screens.dividend_screen>`
+
+.. _screens.growth:
 
 Growth
 ~~~~~~
-* :ref:`Splits<scores.splits_screen>`
+- :ref:`Splits <screens.splits_screen>`
+
+.. _screens.momentum: 
 
 Momentum
 ~~~~~~~~
-* :ref:`Moving Avg<scores.moving_avg_screen>`
-* :ref:`Trading Volume<scores.trading_volume_screen>`
-* :ref:`Splits<scores.splits_screen>`
-
-Value
-~~~~~
+- :ref:`Moving Avg <screens.moving_avg_screen>`
+- Trading Volume (See :ref:`screens.value`)
+- :ref:`Splits <screens.splits_screen>`
 
-.. _scores.trading_volume_screen:
+.. _screens.trading_volume_screen:
 
 Trading Volume
 --------------
 .. automethod:: stockscore.scores.Scores.trading_volume_screen
 
-.. _scores.net_income_screen:
+.. _screens.net_income_screen:
 
 Net Income
 ----------
 .. automethod:: stockscore.scores.Scores.net_income_screen
 
-.. _scores.current_ratio_screen:
+.. _screens.current_ratio_screen:
 
 Current Ratio
 -------------
 .. automethod:: stockscore.scores.Scores.current_ratio_screen
 
-.. _scores.p_to_b_screen:
+.. _screens.pb_ratio_screen:
 
 Price/Book
 ----------
-.. automethod:: stockscore.scores.Scores.p_to_b_screen
+.. automethod:: stockscore.scores.Scores.pb_ratio_screen
 
-.. _scores.p_to_e_screen:
+.. _screens.pe_ratio_screen:
 
 Price/Earnings
 --------------
-.. automethod:: stockscore.scores.Scores.p_to_e_screen
+.. automethod:: stockscore.scores.Scores.pe_ratio_screen
 
-.. _scores.profit_margin_screen:
+.. _screens.profit_margin_screen:
 
 Profit Margin
 -------------
 .. automethod:: stockscore.scores.Scores.profit_margin_screen
 
-.. _scores.dividend_screen:
+.. _screens.dividend_screen:
 
 Dividend
 --------
 .. automethod:: stockscore.scores.Scores.dividend_screen
 
 
-Growth
-~~~~~~
-
-.. _scores.splits_screen:
+.. _screens.splits_screen:
 
 Splits
 ------
 .. automethod:: stockscore.scores.Scores.splits_screen
 
-Momentum
-~~~~~~~~
 
-.. _scores.moving_avg_screen:
+.. _screens.moving_avg_screen:
 
 Moving Avg
 ----------
 .. automethod:: stockscore.scores.Scores.moving_avg_screen
-
-.. _scores.trading_volume_screen:
-
-Trading Volume
---------------
-.. automethod:: stockscore.scores.Scores.trading_volume_screen
-
-.. _scores.splits_screen
-
-Splits
-------
-.. automethod:: stockscore.scores.Scores.splits_screen

github_deploy_key_jackmoody11_stockscore.enc

@@ -0,0 +1 @@
+gAAAAABc0akvCm631eWWs1GID_Agzh28InHFpIO95FGzsHytyaTDTWiAll27tN8D9VbnfZafYKatj8F3rNIprBuip2dReKgzomA2btwbDYOpN1xfMKRWW1eRsLw7TBlV_vvJpWtw2czAQk4LIRpb_50pH0xA06jKyB5F5DUSIrDOMOL6w3pXIiuTb4sIpRxSpEE8pZDmEWC5Ai-mXM3fVnggYUu7wwM7Tla5o2p3DZV63AQxQ4KTNnjVDLJkD4cbUgUVxOEzdBxihJGuFCQSSqIgfAKv1GiVnCZTelfA_o5EUypdg1fna1VV890ofqxPe6is4l-3186b6mUSD81C7VCKtA_3Irf4mf94imxOrYbNkV52QUisxPuHvNL5-0Eb5iXLwxgscFp-XROyMzxHsKKq9LZCvaDRikkqwWZ_VwoF_bmvRTu-BwP3dvalhGAuPkflBAe__J7V5GPzxDd4esoJZtGjm9tzIeyGItb6Dlbwx_OGnZg9asU6j9Q2FscYEuhwuqgoiUHWSgTrqe9gAXVV1Or-b4BvaTyQ0x0uKh-2P-N3eVBxjO24doDzrnrYu-yQVBsGehmS9fon43qMIASJxsq2QITh5pILWzsko2EGGXjyM1N62wej3bRJ2T6py-0hw8RIS9qfUs-Uf0785uPgNUdLiAqJyzztVr0xf1_mz9Q8y4jNVpwXt3jYsyFPeLNi3kVBgLgRvNdXHYssBqXQIPe-xOxORBX_VCAaLXkBo-JUfDlNP8hZ-AcHWreD9UjWZUxjE2_Ty5wgsJKM0RfP6abyOV5r8wogGPTew5I3qD6smxkMi5rI0VAgV-M7jEJDwcUhAgUOYz4V3oQPrddwhgBoZA0tEGeLcY76lAkdTxxQ9DP5l192rXh_oeuRh6VCc6egt5heHI_0Tg-LQdv6AzF4iVAnN2zGsp1dX8HE1XPrl09Ic3YfUVBZT3a4P2u5MZth48tHugh2a0PT8pzKVFX_UcOVQt4lpKfinWFghihT0T2oFhYwKbMZLx3nhDs3jo6BpDZMgfJEoToE51emrmC0RT9Lhi4ikYAAT3Ger3hNOASHmDaT0A4zkRar7I5LV7SLeDXo-dBm_CiBBNYaeKC9CRu9MyN5RFE2elV_9wKVfNPQkooufB6cu702CpnHD5aPmR5zHgBQ1aQbY4u_vNoLcukogFVyE8Ji6ehvoV2jhdYbNpw5n9LvB48uGgCHBIzYW3zcm9dr5infDKifc6qQZR4wewUkNhE6K-TOlY0ERL915_9olKMrszw6IZhBDanQpltAIsRuydnXhnmCYaFxXK0kFs5DbgvqoDJNItQyC_Cg_kAtmhzzF1gPyZheozBM1AEjavv53o4THoMt7MxkFpmpYu7WpHDUDbyJg3EkJl9lQcqDaw_y7LU9Q45-eCZjC2fH18lAVom9lYZZRJu2QuXQiKepmD-rRL6pKfAZpMctfZ1oU_C3lxHe_jGGkIbbnYZwZbZiTh5zKHLYkn2y1BNLzRFAG7nJm7a-l1RQbpCuUxbwc2OePh7S6GFPqinJx-x_ZULz31MB-CSO2_jRbQ3_C05xQqVrp7qrURujx_ObB0nYtatnRoU6qaIeIDMz96q4kbAmSQEKsJdjV0JxcBaxCGHYMnkFYTeK9g5UUhbfHvrD7qhlNYYE1VSm_6QC7fxcz9JK0Ya8OhDLbOwJ_X9hNsK7i5HlFtTvjbe1gUhC8kupdHLr8TZvEMLFwA0RsnBWav14PSTlUE8IfG3iiVQlRs45hpk5i4jtcNTm_yV-qscdfTKbIL9jzDjddKXDXbydTLH2jgWEPur2IS-MjcVevfXXURvfJW1zi1Oc6AaUYnKFgb___C3H6vQjqvW_F8KtplQT22DFtQHs6xBacJ1JvQp_7NUHSq40_dPIIVymbS421YIchRM2ey67GmwOFqCcQ68ouvkBvaRcjWDjnPxrPrfyRmYAdWll736Jyg-eghms0-BRsZWVf9WQYzskGC4feE_jbXYxuwS1eif-FsUyJiy-2XoYG2km8h0peXZbtgkYEhtkn5REcgAPX0CcWcHYe6M2Acv5sxAs4E-gt2A7-fcOJ9JLZmelD4FfUzu2ovxYQOeZs_ywNY_LH3c7iAxhZ9wXpbO2_9bBm1lU-cm6tbM4fYQcP3dKFiUQ-SHMjkpET-JpNQKV6XFxsdrlYu4-7Au6rFQVH65t5RJE0YXSS54Pavh8RMhYWbj_hW10gshYZ7xV8N2fhYY2c8aQ5CcVHLsTNgKJu7ptd-qelVPS5NZqBUN-KZFOh9D62EartI0aQHifwDzZtV1U9kCmHBTaR_73zceh_SRLGiAjmey3JmrAtydoj6mVkZROzba21G9DEChwP2Dury_UW-qXnTG5YB2q642NBPVAe4rfWNyRwIcmnH4xBOXY601U-bcwQGiBK2mrDINHCvHdMb9Zhi9pp1fx5AHVoW9drNvGVj725Uq_oS3nvWW_8A_ywzzuNQwISnlDefEsh6PyZ9UAA9pqIOE0YaCBudM2HMTffNx_dDUM2F5FB_iyZafP4o6i6_6xQMK5wkRbM_dI4IdZ0NsVrdufVoBODsSBp2Y6c91xn9JdyiDbkLoidDRv7OZTcG2yawUBk4Y9kFXMzlptHUbJHNW2NpRUGok9G46n_Y8zPwOzmxkTARHhwY2JOdESIZmdr9r5mKi689yTwWzb3g1AFYJKvAWTGaiakeGRfNxf3VsDQ6hN8RJL5bCnC6mLlLzuVVOZw7EMIsq5YTSecgeNa4srgJ08AyAbuB6d9NrW6Wd3SRfgalfGXGErjvmNAclucLdcY-t00t6n1CmijLqcwGiHMpXewvSas1OZEwVolu4cYlTreJOV58mY1ygpAJ5Re8KYokUitdmmfcFzHGAhpmPUt0foJ1WMK_Rn3rchrV-oWMPdU9m0pRvn2rgqighcuxF2HXc2nVPs8Yz_MTc0VPySTktH2W5A8kJPuQuhEbdDoNqIx-5_GKSZU4oLD8POqz-CCGX6eQ-GDL7as5wN_jM-pfn197_X6wFL0j_3n-21zyHWadkT4d92b_8YLyTdRZHF1-BBTHhadZkNOVV2DsQ4tAx59FqBJblhUbXJjtljwSLwnyXrp0K4SoM0zRQU0biGPowYp1NZcADyfg01ykq8OSJprLjn944RQUVrVa_ir_v_DHjMS0pW9yxgReDIksWdLukgUx07WrPcUry5aXwEDk3xnxLBkTeANCfArWFYZvjSLcTZQ2j9ySVUAuPKg1F9Alj_y10GbRYflrW_QNWzVwkdbr-t4LQBb6F-RLpOyHIvDsZigUgXrOfPvSnayyarkNulsYQvK85Y953th6uRGuE0_zz7ovCejXADG9Urk2b9GqzVD6p9IaNbGc1aXTH2TUGORwYgjd55fvbvXXVLtUX9AIR29bU80CMGFXtutWpiB3qsqbWu8VoFQVmxnMFO2gFDWj3kh9iUbw2KbQhOfQl7euM71plk85em1lFBKG4_5vSoWzCTOP0O2AJKrf9gC09unKySGeSlgIqRLpqGPcusn-7DJzXnGNWzmZqBndeZJnfVtACf4Y3jyKk1vFRVMvc1CsiTL9rlnt3wV5a0LMYvvbOVp1arc5QEu1RWQrfhQZEOGAKbC2PvrdW1cAoIS1mjhKt-EaUM8Tkox5C2C2k893uPcj8nHrJNUYNNFiTos9aLGU7WMCq8Gba8gBgY7SE03eXgxZQvQS4rLdSRF4hXgtH7-Tz7660dbwTqAdEmfI-cjJMafYf25CNDz-euISjaDNH37lPwYw-vt3bPo8mEs7BNUTyaHeQ138FEuot6gFiLJM5HYte8zygEUoBAXZFtVZP967KL8Ozj-90P2StsBBNhWEWmIAawpT-uKxevSjuOBuozmHK-Y102VqnU6VhVEyR-4cqzduBKY-wPzGJPc1AVLvTKSHbQ-rlZsuCkipcXrXw0qo3N4KmT9sn5pb19Y0DBYb99BulWVv4twYss9BAn3C5WRNTjS6H_IjcrldPcGt4YxIR1S-ZMOhFMxEIriWOdoCivN0238GQbQ3sDMn83_hwI0bsQO7buoBDopoJryhhYMm9I5rXbq1KymTSfw7ndIEaAzBCoZclE7hR_3Tf6LXthVv8z0mwYYaq_xWY6Z7y6fbjgQR3M_8VGrIYb2EG6kzmOD_aNr7Hzasxm7qS3yArHEKw2-i9xJ_Sk36ojt6Ix4SWWfP7w63fxkmKynXHbY4lC38i07bqww3cdTWzmrCZOexNVVo5wGBF5SDjhTT8b5fvzbbGtVK4i4tHDsP9R9_RRTXgxncXS3FvNgqoyReP3KeVMMAWQzw570vDZ2qvuSa_F7KRpXb-rCNrkkXlsSrKZQPWFjFIo-RBRE-KuvnAKq3-8wsXIEUVqR2YQPR_G_KX-1ZKBwoW4k0tLCzRob2JWTdrI0nFw52sPPge-Vd_EIXUKmA==

requirements.txt

@@ -1,38 +1,5 @@
-appdirs==1.4.3
-aspy.yaml==1.1.1
-atomicwrites==1.2.1
-attrs==18.2.0
-beautifulsoup4==4.7.1
-black==18.6b4
-bs4==0.0.1
-cached-property==1.5.1
-certifi==2018.11.29
-cfgv==1.4.0
-chardet==3.0.4
-Click==7.0
-cycler==0.10.0
-gevent==1.4.0
-greenlet==0.4.15
-grequests==0.3.0
-identify==1.1.8
-idna==2.7
-iexfinance==0.3.4
-kiwisolver==1.0.1
-matplotlib==2.2.3
-more-itertools==5.0.0
-nodeenv==1.3.3
-numpy==1.15.4
-pandas==0.23.3
-pluggy==0.6.0
-pre-commit==1.11.2
-py==1.7.0
-pyparsing==2.3.1
-pytest==3.6.3
-python-dateutil==2.7.5
-pytz==2018.9
-PyYAML==4.2b1
-requests==2.20.0
-six==1.12.0
-soupsieve==1.7.1
-toml==0.10.0
-urllib3>=1.24.2
+grequests
+iexfinance
+matplotlib
+pandas
+requests

setup.cfg

@@ -0,0 +1,3 @@
+
+[flake8]
+max-line-length = 100

stockscore.py

@@ -43,9 +43,9 @@ def score_stocks(num_stocks):
     # Run screens to find top stocks
     top = score_stocks(stock_count)
     stocks = list(top.index)
-    print(f"The top {stock_count} stocks are {stocks}")
+    print("The top {stock_count} stocks are {stocks}".format(stock_count=stock_count, stocks=stocks))
     # End timer
     end = time.time()
-    print(f"That took {end - begin:.2f} seconds")
+    print("That took {time} seconds".format(time=end - begin))
     # Plot top stocks in bar chart
     plot_top(top)

stockscore/__init__.py

@@ -1 +1,2 @@
-__version__ == '0.4.0'
+__version__ = '0.4.0'
+__author__ = 'Jack Moody'