Dividends
=========

The ``DividendTransactions`` class consumes raw dividend
records (:class:`richy.shares.models.Dividend` /
:class:`richy.etfs.models.Dividend`) and the user's transaction
history, and creates one
:class:`~richy.transactions.models.ShareDividendTransaction` (or
:class:`~richy.transactions.models.EtfDividendTransaction`) row
per ``(user, dividend)`` pair, recording how many shares the
user held on the dividend's payment date and the total cash
payout.

The class is instantiated for a single asset -- pass exactly
one of ``share=`` or ``etf=`` to the constructor. Calling
:meth:`~DividendTransactions.calculate` walks every user with
at least one transaction. Dividends with a future payment date
are skipped; positions closed before the payment date receive
no dividend record; any previously-created records for users
who no longer hold the asset are deleted on the next
``calculate()`` pass.

DividendTransactions
--------------------

.. autoclass:: richy.transactions.dividends.DividendTransactions
   :show-inheritance:

.. automethod:: richy.transactions.dividends.DividendTransactions.calculate