Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@MadeInPierre
MadeInPierre committed Feb 8, 2024
1 parent 3aac351 commit 21b481e
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 26 deletions.
2 changes: 2 additions & 0 deletions README.fr.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ pip install finalynx # exécuter à nouveau avec --upgrade pour mettre à jour

Et c'est tout ! Maintenant, créez votre propre copie de l'exemple [`demo.py`](https://github.com/MadeInPierre/finalynx/blob/main/examples/demo.py) n'importe où et exécutez-le pour vous assurer que tout fonctionne. Vous pouvez maintenant le personnaliser pour vos propres besoins 🚀

**Débutants:** Voici des [étapes détaillées](https://finalynx.readthedocs.io/en/latest/quickstart/installation.html#detailed-instructions) et une [vidéo](https://www.terminalizer.com/view/5fcce8cb5875). N'hésitez pas à [ouvrir une discussion](https://github.com/MadeInPierre/finalynx/discussions), avec plaisir pour aider !

**Pro Tip 💡:** _Pourquoi pas créer un script pour lancer le projet dans un terminal à chaque démarrage ? Jolie vue_ 🤭

## ⚙️ Utilisation et documentation
Expand Down
6 changes: 4 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ Don't have Finary yet? You can sign up using my [referral link](https://finary.c
</div>
</summary>

| Recommendations | Web dashboard |
| --- | --- |
| Recommendations | Web dashboard |
| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| <img src="https://raw.githubusercontent.com/MadeInPierre/finalynx/main/docs/_static/screenshot_recommendations.png" width="600" /> | <img src="https://raw.githubusercontent.com/MadeInPierre/finalynx/main/docs/_static/screenshot_dashboard.png" width="600" /> |

Finalynx also includes a daily budget manager to classify your expenses and show monthly & yearly statistics:
Expand Down Expand Up @@ -72,6 +72,8 @@ pip install finalynx # run again with --upgrade to update

And you're done! Now create your own copy of the [`demo.py`](https://github.com/MadeInPierre/finalynx/blob/main/examples/demo.py) example anywhere and run it to make sure everything works. You can now customize it for your own needs 🚀

**Beginners:** Here are detailed steps in the [documentation](https://finalynx.readthedocs.io/en/latest/quickstart/installation.html#detailed-instructions) or a [video](https://www.terminalizer.com/view/5fcce8cb5875). Feel free to [open a discussion](https://github.com/MadeInPierre/finalynx/discussions) for help!

**Pro Tip 💡:** _Why not setup a script to autorun your config in a new terminal on startup? Could be a nice view_ 🤭

## ⚙️ Usage & Documentation
Expand Down
65 changes: 41 additions & 24 deletions examples/full_example.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@
bank_n26 = Envelope("N26", "N26")
bank_boursorama = Envelope("BoursoBank", "BOU")
bank_revolut = Envelope("Revolut", "REV")
bank_lydia = Envelope("Lydia", "LYD")

pea = PEA("Bourse Direct", "PEA", date(2022, 7, 1), key="MR LACLAU PIERRE (Compte PEA)")
pee = PEE(
Expand Down Expand Up @@ -146,17 +147,39 @@
AssetClass.CASH,
AssetSubclass.CCP,
key="CCP N26",
target=TargetRange(100, 500, tolerance=100),
target=TargetRange(100, 500, tolerance=50),
envelope=bank_n26,
),
Line(
"Revolut",
AssetClass.CASH,
AssetSubclass.CCP,
key="Revolut Current EUR",
target=TargetRange(100, 500, tolerance=100),
target=TargetRange(100, 500, tolerance=50),
envelope=bank_revolut,
),
Line(
"Boursorama (à remplacer)",
AssetClass.CASH,
AssetSubclass.CCP,
key="CCP Boursorama",
envelope=bank_boursorama,
),
Line(
"Lydia Perso",
AssetClass.CASH,
AssetSubclass.CCP,
target=TargetMax(100, tolerance=50),
key="Compte principal",
envelope=bank_lydia,
),
Line(
"Toothless",
AssetClass.CASH,
AssetSubclass.CCP,
target=TargetRange(100, 500, tolerance=50),
envelope=bank_lydia,
),
],
),
Folder(
Expand Down Expand Up @@ -222,6 +245,14 @@
target=TargetRatio(0),
display=FolderDisplay.LINE,
),
Line(
"Liquidités PEA",
AssetClass.CASH,
AssetSubclass.LIQUIDITY,
key="13577959",
envelope=pea,
target=TargetRatio(0),
),
Line(
"Fonds euro",
AssetClass.GUARANTEED,
Expand All @@ -236,7 +267,7 @@
),
Folder(
"Immobilier papier",
target=TargetRatio(10),
target=TargetRatio(15),
perf=LinePerf(4.5),
children=[
Line(
Expand Down Expand Up @@ -378,12 +409,12 @@
),
Folder(
"Défense",
target=TargetRatio(10, zone=2),
target=TargetRatio(5, zone=2),
children=[
Folder(
"Or",
display=FolderDisplay.LINE,
target=TargetRatio(60, zone=2),
target=TargetRatio(50, zone=2),
perf=LinePerf(2),
children=[
Line(
Expand All @@ -405,7 +436,7 @@
Folder(
"Cryptos",
display=FolderDisplay.LINE,
target=TargetRatio(40, zone=2),
target=TargetRatio(50, zone=2),
perf=LinePerf(0),
newline=True,
children=[
Expand Down Expand Up @@ -442,7 +473,7 @@
],
),
Folder(
"Retraite",
"PER Retraite",
perf=LinePerf(0, skip=True),
children=[
Line(
Expand All @@ -454,15 +485,15 @@
perf=LinePerf(5.5),
),
Line(
"Fonds Euro PER",
"Fonds Euro",
AssetClass.GUARANTEED,
AssetSubclass.FOND_EURO,
key="319493",
envelope=per_linxea,
perf=LinePerf(3.5),
),
Line(
"Prefon PER",
"Prefon",
AssetClass.GUARANTEED,
AssetSubclass.FOND_EURO,
key="22276",
Expand All @@ -475,21 +506,6 @@
"En attente",
perf=LinePerf(0, skip=True),
children=[
Line(
"Boursorama (à remplacer)",
AssetClass.CASH,
AssetSubclass.CCP,
key="CCP Boursorama",
envelope=bank_boursorama,
),
Line(
"Liquidités PEA (à investir)",
AssetClass.CASH,
AssetSubclass.LIQUIDITY,
key="13577959",
envelope=pea,
target=TargetMax(0),
),
Line(
"AXA Court Terme (à arbitrer)",
AssetClass.CASH,
Expand Down Expand Up @@ -541,6 +557,7 @@
bank_n26,
bank_boursorama,
bank_revolut,
bank_lydia,
pea,
pee,
av_linxea,
Expand Down

0 comments on commit 21b481e

Please sign in to comment.