finance-py, branch mainPython library for financehttps://cgit.xengineering.eu/finance-py/atom2024-09-15T18:58:59Ztools: Rename check_source.sh to check.sh2024-09-15T18:58:59Zxengineeringme@xengineering.eu2024-09-15T18:58:59Zurn:sha1:1ab3020d072b91917e6ee6f27ac65590ebe994d2Split flow.py to simulate.py and model.py2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-08T15:02:33Zurn:sha1:458a24d09f95eefb161728d9676ecdfca30e3f5e
model.py should be a file containing only dataclasses to model finance.
simulate.py should take care of the simulation of that finance data to
create a financial forecast.
Refactor finance.visualize.py2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-08T12:13:41Zurn:sha1:6973093a2b80b4fb9e216d1b3e329dd4c2badc7c
This introduces the plot() helper function to plot the default data
format list[tuple[datetime, Decimal]] with matplotlib.
Do not rotate dates in visualization2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-08T11:21:17Zurn:sha1:b533a3c32ef6c0b8c425ac47b683179060810a1cRename demo -> demo.py2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-08T10:56:05Zurn:sha1:8bfe0176a00b11b09365925eb57e383d024a63ec
This makes sure this script is also detected by the tools used in
tools/check_source.sh.
In general it is not a bad idea to use a file name extension to indicate
the file type. This improves compatibility with other tools in general.
The downside is that command line tools usually should not have a file
name extension. This can be worked around by using symlinks or an
install step. Both can remove the file name extension.
Use list[tuple[datetime, Decimal]] consistently2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-08T10:46:20Zurn:sha1:7521277860b377e3e9ec7b6d5a62c4c2c14d694f
This type is useful for finance-py in general. It is often required to
handle money in datetime context. Using this type consistently makes the
code easier to read and maintain.
Add measured values2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-08T10:36:43Zurn:sha1:4e8d17c8d0b7d5406d3a9df8c320b5cbabb9d330Move display() to finance.visualize.py2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-08T09:37:41Zurn:sha1:2560d862d5019db1b103a6e6a9c14dfa66afe78dFix type annotation for finance.flow.simulate()2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-08T09:36:40Zurn:sha1:599ef8b119d0b37791b53d9f3a14eeaa658421b1Add second flow to demo2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-08T09:12:00Zurn:sha1:51e67cebb905e7831e3a2d9f706a6d756d69fa71
This makes the output less trivial.
Add demo script2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-08T09:09:43Zurn:sha1:8bf63bc6bb62f2cc2d52ae7e09424c308ff08362Implement finance.flow.display()2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-08T09:03:45Zurn:sha1:9faaac7e25d2efdca36dcb67f96960d3ab72ab82Implement finance.flow.simulate()2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-08T08:02:58Zurn:sha1:fb479fcd7a477959157bdeb9543f11c8b9e8870cFix old usage of name "income"2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-07T18:44:28Zurn:sha1:56219157290495bf58b05a060a2d2afedea735ad
This was renamed to "flow".
Implement Flow.since and Flow.until2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-07T18:43:15Zurn:sha1:36936455e7805f824cb07fe9b23500a882426f98
That way a flow can be limited to a certain time frame.
Refactor Flow.integrate()2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-04T19:09:42Zurn:sha1:226f5afa968ead223baa5a1b0fafb481f9761f0f
This refactoring introduces a generator function supporting the
integration. It creates datetime candidates where it can be checked if
they are in the time interval given to the integration method.
Furthermore a numerical improvement was made. The Flow.integrate()
function now checks candidates from the helper function and sums the
matching candidates up as an integer. After checking all candidates the
integer is converted to a decimal and multiplied by Flow.amount.
This is more accurate because in Python decimal calculation not numbers
or calculations are rounded, just the result of a calculation. Looping
over the candidates and adding amount each time thus involves a rounding
operation per candidate. The new algorithm has exactly one rounding
operation.
Rename income to flow2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-04T18:56:03Zurn:sha1:877b50ef8802f8b59d81ccabcab22fe185e898d7
Modeling income and expenses separately does not make sense since the
only difference is the sign of the amount. Separate definitions would
lead to a lot of duplicated code.
Switch to decimal.Decimal for money2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-04T18:16:15Zurn:sha1:b85de39cd765164d5a31836cb7ca106ad6e328a7
Floating point data types are not suitable to represent money since
rounding issues will sum up.
finance: Use datetime for Income.integrate()2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-03T19:34:08Zurn:sha1:4f3d4de3796744ee1d6d0e91e8bec76e0487de90
Time-based Integration in general is done between two time stamps. For
the financial context it makes sense to use Python's datetime.datetime
class for this purpose.
This commit implements integrating an income between two
datetime.datetime time stamps.
finance: Add income.py2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-03T18:24:42Zurn:sha1:b0b34adbd86fc778923a766273c145cc657918cd
This is the minimal starting point to model financial income.
tools: Add check_source.sh2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-03T17:56:18Zurn:sha1:8043151dc8f80bdffaef1e98e1e33acc36bd58d5
This script checks for common programming errors in the Python code of
this repository.
It might be symlinked by `.git/hooks/pre-commit` to make sure those
errors do not end up in the Git history.
finance: Add empty Python package2024-09-08T15:21:32Zxengineeringme@xengineering.eu2024-09-03T17:41:41Zurn:sha1:95763696b3a1cbc34c25e8efd701b876a8b76f82
This package should contain the primary content of this repository.
Add Apache License 2.0 as LICENSE.txt2024-09-08T15:21:28Zxengineeringme@xengineering.eu2024-09-03T17:40:50Zurn:sha1:b7aaf19f45f1fd75bea40815b24a373b09d28d43Add README.md2024-09-03T17:40:39Zxengineeringme@xengineering.eu2024-09-03T17:40:39Zurn:sha1:775936b83cb6f683e88359747ae28fe85f80c097