finalynx


Namefinalynx JSON
Version 1.22.4 PyPI version JSON
download
home_page
SummaryA command line investment assistant to organize your portfolio and simulate its future to reach your life goals.
upload_time2024-01-13 16:27:57
maintainer
docs_urlNone
authorMadeInPierre
requires_python>=3.10,<4.0
licenseGPLv3
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1 align="center">
  <a href="https://github.com/MadeInPierre/finalynx">
    <img src="https://raw.githubusercontent.com/MadeInPierre/finalynx/main/docs/_static/logo_assistant_transparent.png" width="400" />
  </a>
  <br>Finalynx Assistant<br>
</h1>

<div align="center">
  View in <a href="https://github.com/MadeInPierre/finalynx/blob/main/README.md">English πŸ‡¬πŸ‡§</a> / Lire en <a href="https://github.com/MadeInPierre/finalynx/blob/main/README.fr.md">FranΓ§ais πŸ‡«πŸ‡·</a>

  <br>

  <h4>Minimalistic command-line tool to help you manage your investments</h4>
  <a href="https://pypi.org/project/finalynx/"><img alt="PyPI" src="https://img.shields.io/pypi/v/finalynx?style=flat-square"></a>
  <a href="https://github.com/MadeInPierre/finalynx/actions/workflows/semantic-release.yml"><img alt="GitHub Workflow Status (main)" src="https://img.shields.io/github/actions/workflow/status/madeinpierre/finalynx/semantic-release.yml?branch=main&style=flat-square"></a>
  <a href="https://github.com/MadeInPierre/finalynx/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/madeinpierre/finalynx?style=flat-square"></a>
  <a href="https://github.com/sponsors/MadeInPierre"><img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/MadeInPierre?style=flat-square"></a>
  <a href="https://github.com/finary-wealth/awesome"><img alt="Mentioned in Awesome Finary" src="https://awesome.re/mentioned-badge-flat.svg"></a>

  <sub>Built with ❀︎ by <a href="https://github.com/sponsors/MadeInPierre">Pierre Laclau</a> and <a href="https://github.com/MadeInPierre/finalynx/graphs/contributors">contributors</a>. Logo generated by <a href="https://midjourney.com">Midjourney</a>.</sub>

  <br>
</div>

Finalynx is your "Finary Assistant", a command-line (and experimental web dashboard) tool to organize your investments portfolio and get automated monthly investment recommendations based on your future life goals.
This tool synchronizes with your Finary account to show real-time investment values.

Don't have Finary yet? You can sign up using my [referral link](https://finary.com/referral/f8d349c922d1e1c8f0d2) 🌹 (or through the [default](https://finary.com/signup) page).

<p align="center">
  <img src="https://raw.githubusercontent.com/MadeInPierre/finalynx/main/docs/_static/screenshot_demo_frameless.png" width="600" />
</p>

<details>
<summary>
  <div align="center">
    <strong>[Click]</strong> Additional screenshots πŸ“Έ
  </div>
</summary>

| 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:

<img src="https://raw.githubusercontent.com/MadeInPierre/finalynx/main/docs/_static/budget.png"/>

<img src="https://raw.githubusercontent.com/MadeInPierre/finalynx/main/docs/_static/budget_review.png"/>

Statistics and visualizations will be added soon!

</details>

## ✨ Features

1. **βœ… Portfolio:** Organize your assets, set targets, and sync with your Finary account.
2. **βœ… Assistant:** Get monthly recommendations on where to invest next to meet your goals.
3. **βœ… Simulator:** Define your life goals and events, simulate your portfolio's future.
4. **⏳ Web dashboard:** Generate global statistics and graphs to understand each line and folder.
5. **πŸ™ Extensions:** Make this tool work for other people's situations, contributions needed πŸ‘€

You can check the [current development status](https://github.com/users/MadeInPierre/projects/4). Contributions are warmly welcome!

## πŸš€ Installation

If you don't plan on touching the code, simply run (with python >=3.10 and pip installed):

```sh
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 πŸš€

**Pro Tip πŸ’‘:** _Why not setup a script to autorun your config in a new terminal on startup? Could be a nice view_ 🀭

## βš™οΈ Usage & Documentation

The goal is to declare a tree structure of your entire portfolio independently from their host envelopes (e.g. PEA, AV, CTO, etc). Once your entire portfolio strategy is defined here, find the best envelope for each line and add them to your Finary account (manual or automatic sync). Finalynx will fetch each line and display your full portfolio with real-time amounts.

Here is the bare minimum code accepted:

```python
from finalynx import Portfolio, Assistant
portfolio = Portfolio()     # <- your custom configuration here
Assistant(portfolio).run()  # <- see tutorials for more options
```

You can now populate the `Portfolio` class with your own custom hierarchy by taking inspiration from the [`demo.py`](https://github.com/MadeInPierre/finalynx/blob/main/examples/demo.py) example or by reading the [Getting Started](https://finalynx.readthedocs.io/en/latest/quickstart/getting_started.html) guide in the documentation and step-by-step [Tutorials](https://github.com/MadeInPierre/finalynx/tree/main/examples/tutorials). For additional details, checkout the full [API Reference](https://finalynx.readthedocs.io/en/latest/apidocs/index.html) or [ask a question](https://github.com/MadeInPierre/finalynx/discussions/new?category=q-a).

Once you have a fully defined portfolio tree with sensible targets, you can display how much you need to invest in each line using:

```sh
python your_config.py delta  # type --help for other options, like launching a web dashboard!
```

## πŸ‘¨β€πŸ’» Feedback & Contributions

This repository is at a very early stage. Unfortunately, I won't have time to make this tool work for everyone by default, but you are welcome to extend this project (or [hire me](https://github.com/sponsors/MadeInPierre/commissions) if you can't develop it yourself). Pull requests, [issues](https://github.com/MadeInPierre/finalynx/issues/new) (πŸ‡¬πŸ‡§ preferably) and [open discussions](https://github.com/MadeInPierre/finalynx/discussions/new) (πŸ‡¬πŸ‡§/πŸ‡«πŸ‡·) are warmly welcome!

If you would like to contribute to this project, welcome on board and thanks for your interest! πŸŽ‰ Please read the [contribution guidelines](https://github.com/MadeInPierre/finalynx/blob/main/CONTRIBUTING.md) to setup the project on your machine and agree on common conventions.

## πŸ“„ License

This project is under the [GPLv3 License](https://github.com/MadeInPierre/finalynx/blob/main/LICENSE) meaning anyone can use, share, extend, and contribute to this project as long as their changes are integrated to this repo or also published using GPLv3. Please contact me for any specific licensing requests.

## πŸ’Œ Donations

[<img align="right" src="https://www.mathisplumail.com/wp-content/uploads/2021/04/coffee.png" width="161" />](https://github.com/sponsors/MadeInPierre)
This is a personal project I have fun with on my free time. If you found it useful and wish to support my work, you can [buy me a coffee](https://github.com/sponsors/MadeInPierre)! It would give me the motivation to keep improving it further πŸ˜„ Thank you!

Also, big thanks to all contributors 🌹 don't forget to check them out:

<a href="https://github.com/MadeInPierre/finalynx/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=MadeInPierre/finalynx" />
</a>

<!-- Breaking: :boom:

Minor: :sparkles::children_crossing::lipstick::iphone::egg::chart_with_upwards_trend:

Patch: :ambulance::lock::bug::zap::goal_net::alien::wheelchair::speech_balloon::mag::apple::penguin::checkered_flag::robot::green_apple: -->

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "finalynx",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "MadeInPierre",
    "author_email": "pielaclau@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/0c/09/76d8011f2cc7ef64f2b5bd115989ff033fdfb9d4ebcf7b744923263d4511/finalynx-1.22.4.tar.gz",
    "platform": null,
    "description": "<h1 align=\"center\">\n  <a href=\"https://github.com/MadeInPierre/finalynx\">\n    <img src=\"https://raw.githubusercontent.com/MadeInPierre/finalynx/main/docs/_static/logo_assistant_transparent.png\" width=\"400\" />\n  </a>\n  <br>Finalynx Assistant<br>\n</h1>\n\n<div align=\"center\">\n  View in <a href=\"https://github.com/MadeInPierre/finalynx/blob/main/README.md\">English \ud83c\uddec\ud83c\udde7</a> / Lire en <a href=\"https://github.com/MadeInPierre/finalynx/blob/main/README.fr.md\">Fran\u00e7ais \ud83c\uddeb\ud83c\uddf7</a>\n\n  <br>\n\n  <h4>Minimalistic command-line tool to help you manage your investments</h4>\n  <a href=\"https://pypi.org/project/finalynx/\"><img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/finalynx?style=flat-square\"></a>\n  <a href=\"https://github.com/MadeInPierre/finalynx/actions/workflows/semantic-release.yml\"><img alt=\"GitHub Workflow Status (main)\" src=\"https://img.shields.io/github/actions/workflow/status/madeinpierre/finalynx/semantic-release.yml?branch=main&style=flat-square\"></a>\n  <a href=\"https://github.com/MadeInPierre/finalynx/blob/main/LICENSE\"><img alt=\"License\" src=\"https://img.shields.io/github/license/madeinpierre/finalynx?style=flat-square\"></a>\n  <a href=\"https://github.com/sponsors/MadeInPierre\"><img alt=\"GitHub Sponsors\" src=\"https://img.shields.io/github/sponsors/MadeInPierre?style=flat-square\"></a>\n  <a href=\"https://github.com/finary-wealth/awesome\"><img alt=\"Mentioned in Awesome Finary\" src=\"https://awesome.re/mentioned-badge-flat.svg\"></a>\n\n  <sub>Built with \u2764\ufe0e by <a href=\"https://github.com/sponsors/MadeInPierre\">Pierre Laclau</a> and <a href=\"https://github.com/MadeInPierre/finalynx/graphs/contributors\">contributors</a>. Logo generated by <a href=\"https://midjourney.com\">Midjourney</a>.</sub>\n\n  <br>\n</div>\n\nFinalynx is your \"Finary Assistant\", a command-line (and experimental web dashboard) tool to organize your investments portfolio and get automated monthly investment recommendations based on your future life goals.\nThis tool synchronizes with your Finary account to show real-time investment values.\n\nDon't have Finary yet? You can sign up using my [referral link](https://finary.com/referral/f8d349c922d1e1c8f0d2) \ud83c\udf39 (or through the [default](https://finary.com/signup) page).\n\n<p align=\"center\">\n  <img src=\"https://raw.githubusercontent.com/MadeInPierre/finalynx/main/docs/_static/screenshot_demo_frameless.png\" width=\"600\" />\n</p>\n\n<details>\n<summary>\n  <div align=\"center\">\n    <strong>[Click]</strong> Additional screenshots \ud83d\udcf8\n  </div>\n</summary>\n\n| Recommendations | Web dashboard |\n| --- | --- |\n| <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\" /> |\n\nFinalynx also includes a daily budget manager to classify your expenses and show monthly & yearly statistics:\n\n<img src=\"https://raw.githubusercontent.com/MadeInPierre/finalynx/main/docs/_static/budget.png\"/>\n\n<img src=\"https://raw.githubusercontent.com/MadeInPierre/finalynx/main/docs/_static/budget_review.png\"/>\n\nStatistics and visualizations will be added soon!\n\n</details>\n\n## \u2728 Features\n\n1. **\u2705 Portfolio:** Organize your assets, set targets, and sync with your Finary account.\n2. **\u2705 Assistant:** Get monthly recommendations on where to invest next to meet your goals.\n3. **\u2705 Simulator:** Define your life goals and events, simulate your portfolio's future.\n4. **\u23f3 Web dashboard:** Generate global statistics and graphs to understand each line and folder.\n5. **\ud83d\ude4f Extensions:** Make this tool work for other people's situations, contributions needed \ud83d\udc40\n\nYou can check the [current development status](https://github.com/users/MadeInPierre/projects/4). Contributions are warmly welcome!\n\n## \ud83d\ude80 Installation\n\nIf you don't plan on touching the code, simply run (with python >=3.10 and pip installed):\n\n```sh\npip install finalynx  # run again with --upgrade to update\n```\n\nAnd 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 \ud83d\ude80\n\n**Pro Tip \ud83d\udca1:** _Why not setup a script to autorun your config in a new terminal on startup? Could be a nice view_ \ud83e\udd2d\n\n## \u2699\ufe0f Usage & Documentation\n\nThe goal is to declare a tree structure of your entire portfolio independently from their host envelopes (e.g. PEA, AV, CTO, etc). Once your entire portfolio strategy is defined here, find the best envelope for each line and add them to your Finary account (manual or automatic sync). Finalynx will fetch each line and display your full portfolio with real-time amounts.\n\nHere is the bare minimum code accepted:\n\n```python\nfrom finalynx import Portfolio, Assistant\nportfolio = Portfolio()     # <- your custom configuration here\nAssistant(portfolio).run()  # <- see tutorials for more options\n```\n\nYou can now populate the `Portfolio` class with your own custom hierarchy by taking inspiration from the [`demo.py`](https://github.com/MadeInPierre/finalynx/blob/main/examples/demo.py) example or by reading the [Getting Started](https://finalynx.readthedocs.io/en/latest/quickstart/getting_started.html) guide in the documentation and step-by-step [Tutorials](https://github.com/MadeInPierre/finalynx/tree/main/examples/tutorials). For additional details, checkout the full [API Reference](https://finalynx.readthedocs.io/en/latest/apidocs/index.html) or [ask a question](https://github.com/MadeInPierre/finalynx/discussions/new?category=q-a).\n\nOnce you have a fully defined portfolio tree with sensible targets, you can display how much you need to invest in each line using:\n\n```sh\npython your_config.py delta  # type --help for other options, like launching a web dashboard!\n```\n\n## \ud83d\udc68\u200d\ud83d\udcbb Feedback & Contributions\n\nThis repository is at a very early stage. Unfortunately, I won't have time to make this tool work for everyone by default, but you are welcome to extend this project (or [hire me](https://github.com/sponsors/MadeInPierre/commissions) if you can't develop it yourself). Pull requests, [issues](https://github.com/MadeInPierre/finalynx/issues/new) (\ud83c\uddec\ud83c\udde7 preferably) and [open discussions](https://github.com/MadeInPierre/finalynx/discussions/new) (\ud83c\uddec\ud83c\udde7/\ud83c\uddeb\ud83c\uddf7) are warmly welcome!\n\nIf you would like to contribute to this project, welcome on board and thanks for your interest! \ud83c\udf89 Please read the [contribution guidelines](https://github.com/MadeInPierre/finalynx/blob/main/CONTRIBUTING.md) to setup the project on your machine and agree on common conventions.\n\n## \ud83d\udcc4 License\n\nThis project is under the [GPLv3 License](https://github.com/MadeInPierre/finalynx/blob/main/LICENSE) meaning anyone can use, share, extend, and contribute to this project as long as their changes are integrated to this repo or also published using GPLv3. Please contact me for any specific licensing requests.\n\n## \ud83d\udc8c Donations\n\n[<img align=\"right\" src=\"https://www.mathisplumail.com/wp-content/uploads/2021/04/coffee.png\" width=\"161\" />](https://github.com/sponsors/MadeInPierre)\nThis is a personal project I have fun with on my free time. If you found it useful and wish to support my work, you can [buy me a coffee](https://github.com/sponsors/MadeInPierre)! It would give me the motivation to keep improving it further \ud83d\ude04 Thank you!\n\nAlso, big thanks to all contributors \ud83c\udf39 don't forget to check them out:\n\n<a href=\"https://github.com/MadeInPierre/finalynx/graphs/contributors\">\n  <img src=\"https://contrib.rocks/image?repo=MadeInPierre/finalynx\" />\n</a>\n\n<!-- Breaking: :boom:\n\nMinor: :sparkles::children_crossing::lipstick::iphone::egg::chart_with_upwards_trend:\n\nPatch: :ambulance::lock::bug::zap::goal_net::alien::wheelchair::speech_balloon::mag::apple::penguin::checkered_flag::robot::green_apple: -->\n",
    "bugtrack_url": null,
    "license": "GPLv3",
    "summary": "A command line investment assistant to organize your portfolio and simulate its future to reach your life goals.",
    "version": "1.22.4",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0d8a511cd3de387d1ddb0aa04098bcab1699dfaa840fb3c1ef1178fd34ed82eb",
                "md5": "ffd6e1cdc2b6e7ba366f630150274242",
                "sha256": "6372106773e4d4a4bc749c18810be9178a9fa25dec59c63d9a5d292baa15a411"
            },
            "downloads": -1,
            "filename": "finalynx-1.22.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ffd6e1cdc2b6e7ba366f630150274242",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 96564,
            "upload_time": "2024-01-13T16:27:55",
            "upload_time_iso_8601": "2024-01-13T16:27:55.109814Z",
            "url": "https://files.pythonhosted.org/packages/0d/8a/511cd3de387d1ddb0aa04098bcab1699dfaa840fb3c1ef1178fd34ed82eb/finalynx-1.22.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0c0976d8011f2cc7ef64f2b5bd115989ff033fdfb9d4ebcf7b744923263d4511",
                "md5": "dd1aeabebe496fa186389c079b0ccb0a",
                "sha256": "91255a3831f8b24ecceb222862cfd2d57a4efdf4d5f9508342548e27037f7aca"
            },
            "downloads": -1,
            "filename": "finalynx-1.22.4.tar.gz",
            "has_sig": false,
            "md5_digest": "dd1aeabebe496fa186389c079b0ccb0a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 77702,
            "upload_time": "2024-01-13T16:27:57",
            "upload_time_iso_8601": "2024-01-13T16:27:57.389809Z",
            "url": "https://files.pythonhosted.org/packages/0c/09/76d8011f2cc7ef64f2b5bd115989ff033fdfb9d4ebcf7b744923263d4511/finalynx-1.22.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-13 16:27:57",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "finalynx"
}
        
Elapsed time: 0.19437s