From 21b481ed96bc7b464121a192dc4c5667e0b7b2c0 Mon Sep 17 00:00:00 2001 From: MadeInPierre Date: Thu, 8 Feb 2024 18:24:17 +0100 Subject: [PATCH] chore: update readme --- README.fr.md | 2 ++ README.md | 6 ++-- examples/full_example.py | 65 +++++++++++++++++++++++++--------------- 3 files changed, 47 insertions(+), 26 deletions(-) diff --git a/README.fr.md b/README.fr.md index aff56cb..333eda0 100644 --- a/README.fr.md +++ b/README.fr.md @@ -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 diff --git a/README.md b/README.md index 76b60f9..447ade3 100644 --- a/README.md +++ b/README.md @@ -38,8 +38,8 @@ Don't have Finary yet? You can sign up using my [referral link](https://finary.c -| Recommendations | Web dashboard | -| --- | --- | +| Recommendations | Web dashboard | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | | | Finalynx also includes a daily budget manager to classify your expenses and show monthly & yearly statistics: @@ -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 diff --git a/examples/full_example.py b/examples/full_example.py index 3ad0fd1..fb2c3fd 100755 --- a/examples/full_example.py +++ b/examples/full_example.py @@ -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( @@ -146,7 +147,7 @@ AssetClass.CASH, AssetSubclass.CCP, key="CCP N26", - target=TargetRange(100, 500, tolerance=100), + target=TargetRange(100, 500, tolerance=50), envelope=bank_n26, ), Line( @@ -154,9 +155,31 @@ 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( @@ -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, @@ -236,7 +267,7 @@ ), Folder( "Immobilier papier", - target=TargetRatio(10), + target=TargetRatio(15), perf=LinePerf(4.5), children=[ Line( @@ -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( @@ -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=[ @@ -442,7 +473,7 @@ ], ), Folder( - "Retraite", + "PER Retraite", perf=LinePerf(0, skip=True), children=[ Line( @@ -454,7 +485,7 @@ perf=LinePerf(5.5), ), Line( - "Fonds Euro PER", + "Fonds Euro", AssetClass.GUARANTEED, AssetSubclass.FOND_EURO, key="319493", @@ -462,7 +493,7 @@ perf=LinePerf(3.5), ), Line( - "Prefon PER", + "Prefon", AssetClass.GUARANTEED, AssetSubclass.FOND_EURO, key="22276", @@ -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, @@ -541,6 +557,7 @@ bank_n26, bank_boursorama, bank_revolut, + bank_lydia, pea, pee, av_linxea,