Welcome to stockscore's documentation!
======================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

The `stockscore` module relies on many common screens. These screens are currently hard-coded 
with pre-defined points (ex: PE ratio between 5 and 10 gives 1 point to value score).

.. _getting_started:

.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   install
   usage
   screens

.. _package_info:

.. toctree::
   :maxdepth: 1
   :caption: Package Information

   about