piotroski
=========

.. py:module:: piotroski


Classes
-------

.. autoapisummary::

   piotroski.Piotroski


Module Contents
---------------

.. py:class:: Piotroski(data)

   Bases: :py:obj:`trading.src.features.generic_features.Feature`


   A class to represent the Piotroski F-Score, a financial metric used to evaluate the strength of a company's financial position.


   .. py:attribute:: data


   .. py:method:: calculate_score()

      Calculates the Piotroski F-Score based on the provided financial data.

      :return: The Piotroski F-Score as an integer.