<commit_before>===============================
Realtime Stock
===============================


.. image:: https://img.shields.io/pypi/v/realtime-stock.svg
        :target: https://pypi.python.org/pypi/realtime-stock

.. image:: https://img.shields.io/travis/condereis/realtime-stock.svg
        :target: https://travis-ci.org/condereis/realtime-stock

.. image:: https://readthedocs.org/projects/realtime-stock/badge/?version=latest
        :target: https://realtime-stock.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. image:: https://pyup.io/repos/github/condereis/realtime-stock/shield.svg
     :target: https://pyup.io/repos/github/condereis/realtime-stock/
     :alt: Updates


Realtime Stock is a Python package to gather realtime stock quotes from Yahoo Finance. The package enables you to handle single stocks or portfolios, optimizing the nunber of requests necessary to gather quotes for a large number of stocks.


* Documentation: https://realtime-stock.readthedocs.io.
* Free software: MIT license


Features
--------

**Stock class**
* Method to get stock's latest price.
* Method to get all stock's information provided by Yahoo Finance.
* Method get stock's daily historical information.
* Method download historical data from Yahoo Finance.

**Utility functions**
* Function to request recent quotes about a list of tickers.
* Function to get stock's daily historical information.
* Function to download historical data from Yahoo Finance.


Installation
------------
To install Realtime Stock, run this command in your terminal:

.. code:: bash

    $ pip install realtime-stock

Check `here <https://realtime-stock.readthedocs.io/en/latest/installation.html>`_  for further information on installation.


Basic Usage
-----------

For single stocks:
<commit_msg>'README.rst'<commit_after>===============================
Realtime Stock
===============================


.. image:: https://img.shields.io/pypi/v/realtime-stock.svg
        :target: https://pypi.python.org/pypi/realtime-stock

.. image:: https://img.shields.io/travis/condereis/realtime-stock.svg
        :target: https://travis-ci.org/condereis/realtime-stock

.. image:: https://readthedocs.org/projects/realtime-stock/badge/?version=latest
        :target: https://realtime-stock.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. image:: https://pyup.io/repos/github/condereis/realtime-stock/shield.svg
     :target: https://pyup.io/repos/github/condereis/realtime-stock/
     :alt: Updates


Realtime Stock is a Python package to gather realtime stock quotes from Yahoo Finance. The package enables you to handle single stocks or portfolios, optimizing the nunber of requests necessary to gather quotes for a large number of stocks.


* Documentation: https://realtime-stock.readthedocs.io.
* Free software: MIT license


Features
--------

**Stock class**

* Method to get stock's latest price.
* Method to get all stock's information provided by Yahoo Finance.
* Method get stock's daily historical information.
* Method download historical data from Yahoo Finance.

**Utility functions**

* Function to request recent quotes about a list of tickers.
* Function to get stock's daily historical information.
* Function to download historical data from Yahoo Finance.


Installation
------------
To install Realtime Stock, run this command in your terminal:

.. code:: bash

    $ pip install realtime-stock

Check `here <https://realtime-stock.readthedocs.io/en/latest/installation.html>`_  for further information on installation.


Basic Usage
-----------

For single stocks:

{'fraction_non_alphanumeric': 0.14813793103448275, 'fraction_numerical': 0.0, 'mean_word_length': 3.7710526315789474, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 20, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3562877', 'n_tokens_mistral': 1064, 'n_tokens_neox': 996, 'n_words': 314}