.. _f-astock:

module ``finance.astock``
=========================





.. inheritance-diagram:: pyensae.finance.astock


Short summary
+++++++++++++

module ``pyensae.finance.astock``

Downloads stock prices (from Yahoo website) and other prices.


:githublink:`%|py|5`




Classes
+++++++

+-------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| class                                                                               | truncated documentation                                                                                            |
+=====================================================================================+====================================================================================================================+
| :class:`StockPrices <pyensae.finance.astock.StockPrices>`                           | Defines a class containing stock prices, provides basic functions, the class uses :epkg:`pandas` to load the data. |
+-------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| :class:`StockPricesException <pyensae.finance.astock.StockPricesException>`         | Raised by StockPrices classes.                                                                                     |
+-------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| :class:`StockPricesHTTPException <pyensae.finance.astock.StockPricesHTTPException>` | Raised by StockPrices classes.                                                                                     |
+-------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+






Properties
++++++++++

+------------------------------------------------------------------+-------------------------+
| property                                                         | truncated documentation |
+==================================================================+=========================+
| :meth:`dataframe <pyensae.finance.astock.StockPrices.dataframe>` | Returns the dataframe.  |
+------------------------------------------------------------------+-------------------------+
| :meth:`shape <pyensae.finance.astock.StockPrices.shape>`         |                         |
+------------------------------------------------------------------+-------------------------+
| :meth:`tick <pyensae.finance.astock.StockPrices.tick>`           | Returns the tick name.  |
+------------------------------------------------------------------+-------------------------+




Static Methods
++++++++++++++

+------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| staticmethod                                                                 | truncated documentation                                                                                                                           |
+==============================================================================+===================================================================================================================================================+
| :meth:`available_dates <pyensae.finance.astock.StockPrices.available_dates>` | Returns the list of values (Open or High or Low or Close or Volume) from each stock for all the available_dates ...                               |
+------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`covariance <pyensae.finance.astock.StockPrices.covariance>`           | Computes the covariances matrix (of returns).                                                                                                     |
+------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`draw <pyensae.finance.astock.StockPrices.draw>`                       | Draws a graph showing one or several time series. The example was taken `date_demo.py <https://matplotlib.org/examples/api/date_demo.html>`_. ... |
+------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+




Methods
+++++++

+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| method                                                                  | truncated documentation                                                                                                                     |
+=========================================================================+=============================================================================================================================================+
| :py:meth:`__getitem__ <pyensae.finance.astock.StockPrices.__getitem__>` | Overloads the ``getitem`` operator to get a :class:`StockPrice` object.                                                                     |
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pyensae.finance.astock.StockPrices.__init__>`       |                                                                                                                                             |
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__len__ <pyensae.finance.astock.StockPrices.__len__>`         |                                                                                                                                             |
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`df <pyensae.finance.astock.StockPrices.df>`                      | Returns the dataframe.                                                                                                                      |
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`FirstDate <pyensae.finance.astock.StockPrices.FirstDate>`        | Returns the first date.                                                                                                                     |
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`head <pyensae.finance.astock.StockPrices.head>`                  | usual                                                                                                                                       |
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`keep_dates <pyensae.finance.astock.StockPrices.keep_dates>`      | removes undesired dates                                                                                                                     |
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`LastDate <pyensae.finance.astock.StockPrices.LastDate>`          | Returns the first date.                                                                                                                     |
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`missing <pyensae.finance.astock.StockPrices.missing>`            | Returnq the list of missing dates from an overset of trading dates.                                                                         |
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`plot <pyensae.finance.astock.StockPrices.plot>`                  | See :meth:`draw <pyensae.finance.astock.StockPrices.draw>`.                                                                                 |
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`returns <pyensae.finance.astock.StockPrices.returns>`            | Builds the series of returns.                                                                                                               |
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`tail <pyensae.finance.astock.StockPrices.tail>`                  | usual                                                                                                                                       |
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`to_csv <pyensae.finance.astock.StockPrices.to_csv>`              | Saves the file in text format, see `to_csv <https://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.to_csv.html>`_ ...      |
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`to_excel <pyensae.finance.astock.StockPrices.to_excel>`          | Saves the file in Excel format, see `to_excel <https://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.to_excel.html>`_ ... |
+-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: pyensae.finance.astock
    :members:
    :special-members: __init__
    :show-inheritance: