Finalynx

Feature

* feat(dashboard): add layered evolution graphs (150) by gcoue

More graphs available in the dashboard with view per classification (envelopes, asset classes, line by line, ...) by gcoue ([`6f0d1b3`](https://github.com/MadeInPierre/finalynx/commit/6f0d1b39d72682fc005fc0e7e28101c725f6b7c5))

Chore

* chore: update full example ([`00138dd`](https://github.com/MadeInPierre/finalynx/commit/00138dd2fcaf2226402b5d1881ee9993624c8cc7))

Fix

* fix(fetch): change credit card to negative amount (147) by gcoue

* feat(simu): Add a flag to render portfolio state for each simulation step (147) by gcoue

Fix

* fix: clarify signup for 2FA, simulation progress bar ([`3b5c9c4`](https://github.com/MadeInPierre/finalynx/commit/3b5c9c4e34f8101e3b0ea1095dbaa83a06e55959))

Documentation

* docs: add simulation template tutorial ([`c15b97c`](https://github.com/MadeInPierre/finalynx/commit/c15b97c9dac452a306745eb0849e13d2b1be75f0))

* docs: add full example ([`de11f6e`](https://github.com/MadeInPierre/finalynx/commit/de11f6ed290e6f510a055b6ab727959538e03608))

* docs: add budget tutorial ([`0fe1513`](https://github.com/MadeInPierre/finalynx/commit/0fe1513c5aeb191eea7cce77ff8fdaa535ddb56e))

* docs: update readme french (141) by Adamou02

* docs: add simulation tutorial, fix typos ([`8c6ab9a`](https://github.com/MadeInPierre/finalynx/commit/8c6ab9a9e9557d18399fa8562fec93701f8da5d7))

Style

* style: minor improvements ([`57b2424`](https://github.com/MadeInPierre/finalynx/commit/57b2424ead1ab1c9a9cc4c89519850a4a732b02b))

Minor feature

* fix(simulation): add salary income & expense growth ([`84e6524`](https://github.com/MadeInPierre/finalynx/commit/84e6524cba7b47fb1e4a4d87dc895d68e796506b))

You can now set the growth rate of your salary and expenses. For example, if you earn 1000€/month
and your salary grows by 3% every year, you can set the `income_growth` to 3% and the salary will
be updated every year (1/12th every month in reality).

You can also set the `expenses_follow` to 100% to follow the income growth:
- If your salary grows by 3%, your expenses will grow of the same amount (100% of the income growth).
- If you set `expenses_follow` to 0%, your expenses will stay the same (0% of the income growth).
- If you set `expenses_follow` to 50%, your expenses will grow by half of the income growth (50% of the income growth).

To use this new feature, you can use the new `Salary` event:

python
livreta = Line("Livret A", ...)

...

assistant = Assistant(
...,
simulation = Simulation(
events=[
Salary(
livreta,
income=3000,
expenses=2000,
income_growth=1, <- 1% growth every year (net of inflation)
expenses_follow=75, <- Save 25% of the income growth
name="My Job",
),
...
]
)
)

Minor feature

* fix(simulator): show portfolio evolution in dashboard, cleanup ([`78c1782`](https://github.com/MadeInPierre/finalynx/commit/78c17827b994b83ee4ebac529c141d77a09b8b9a))

Nothing to change in your config, simply launch the dashboard (with a simulation config even if it's only `Simulation()`) to see your portfolio's evolution based on your events! See the previous release for more information about the simulator.

Tutorial to use the new simulator
The simulator can apply `Actions` wrapped around an `Event` instance. Events define when to perform the action, and can define an optional `Recurrence` to perform the action regularly (e.g. every month, at the end of each year, ...).

There are currently three supported actions for now:
- **ApplyPerformance:** Change the amounts of each `Line` depending on the specified `LinePerf` expected investment performance. By default, this action is already added in the list of events in the configuration and executes on each December 31st.
- **AutoBalance:** For folders and lines that use `TargetRatio` targets, Finalynx will automatically apply the ideal amounts for each `Line`. This corresponds to following the Finalynx recommendations. By default, this event is automatically added and executed every 3 months.
- **Salary**: Specify which `Line` in the portfolio should receive a specific amount each month. This class is simply a shortcut to:

python
Event(AddLineAmount(your_account, 2500), recurrence=MonthlyRecurrence(day_of_the_month, until=end_date))


To activate the simulator with the default events, add the following to your config :

python
from finalynx import Portfolio, Assistant, Simulation
portfolio = Portfolio()
Assistant(portfolio, ..., simulation=Simulation()).run() activate the simulation (with default behavior)


Some other parameters can be set:

python
livreta = Line("Livret A", ...)

portfolio = Portfolio(children=[..., livreta, ...])

buckets = [...] Create a list with the references to your buckets (if any)
envelopes = [...] Create a list with the references to your envelopes (if any)

assistant = Assistant(
portfolio,
buckets,
envelopes,
..., Other options
simulation=Simulation(
events=[ Your personal config of events (salaries for now, more coming soon!)
Salary(livreta, income=2300, expenses=1400, end_date=date(2024, 11, 30)),
Event(AddLineAmount(livreta, 3500), planned_date=date(2024, 4, 10), name="Prime"),
Event(AddLineAmount(livreta, 3500), planned_date=date(2025, 4, 10), name="Prime"),
Salary(livreta, income=3000, expenses=2000, start_date=date(2025, 1, 1), name="Futur Job"),
],
inflation=3.0, Percentage of inflation, will reduce each line's performance by this much
end_date=date(2063, 4, 5), Defaults to 100 years after today
step_years=5, Show a summary of the portfolio's total worth every X years in the console
default_events=True, Add default events to the ones specified above, defaults to True
),
).run()


Please open a discussion topic if you're interested for more information!

---

Build

* build: bump finary_uapi to 0.1.4 ([`dc4bab6`](https://github.com/MadeInPierre/finalynx/commit/dc4bab68a89e6a9df57b9cc64a7acbdb8166cb0b))

Documentation

* docs: add readme french (137) by Strawbang

Features

* feat(simulation): simulate your portfolio&39;s future (136)

* feat: create timeline structure, display worth evolution

* feat: add default event to apply yearly performance

* feat: add autobalance default quarterly event

* fix: ask before fetching from N26

* docs: add docstrings ([`3349f66`](https://github.com/MadeInPierre/finalynx/commit/3349f660c183ada495110349706958ab7cc5d39a))