finary-uapi 0.1.2__tar.gz → 0.1.4__tar.gz

{finary_uapi-0.1.2 → finary_uapi-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: finary-uapi
-Version: 0.1.2
+Version: 0.1.4
 Summary: Finary API client and command line tool to interact with your Finary account.
 License: MIT
 Author: lasconic
@@ -31,7 +31,7 @@ If you don't already have an account, here is a referral link to sign up: https:
 
 ## Quick start 
 
-1. Install requirements. `pip install -r requirements.txt`.
+1. Install requirements. `pip install finary_uapi`.
 2. Copy paste the `credentials.json.tpl` file to `credentials.json` and file your username and password.
 3. Run `python -m finary_uapi signin`
 4. You are good to go and can explore the API. Run `python -m finary_uapi` for available commands.
@@ -137,3 +137,31 @@ python -m finary_uapi dashboard gross all | jq '.result["total"]["amount"]'
 * Delete responses should be normalized, sometimes we get json back sometimes nothing but the 204 HTTP code.
 
 
+
+## Contributors ✨
+
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
+Thanks go to these people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="16.66%"><a href="http://lasconic.com"><img src="https://avatars.githubusercontent.com/u/234271?v=4?s=100" width="100px;" alt="Nicolas Froment"/><br /><sub><b>Nicolas Froment</b></sub></a><br /><a href="#projectManagement-lasconic" title="Project Management">📆</a> <a href="#promotion-lasconic" title="Promotion">📣</a> <a href="https://github.com/lasconic/finary_uapi/commits?author=lasconic" title="Code">💻</a> <a href="https://github.com/lasconic/finary_uapi/issues?q=author%3Alasconic" title="Bug reports">🐛</a> <a href="#ideas-lasconic" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/lasconic/finary_uapi/commits?author=lasconic" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="16.66%"><a href="http://varal7.fr"><img src="https://avatars.githubusercontent.com/u/8019486?v=4?s=100" width="100px;" alt="Victor Quach"/><br /><sub><b>Victor Quach</b></sub></a><br /><a href="https://github.com/lasconic/finary_uapi/commits?author=Varal7" title="Code">💻</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

{finary_uapi-0.1.2 → finary_uapi-0.1.4}/README.md

@@ -14,7 +14,7 @@ If you don't already have an account, here is a referral link to sign up: https:
 
 ## Quick start 
 
-1. Install requirements. `pip install -r requirements.txt`.
+1. Install requirements. `pip install finary_uapi`.
 2. Copy paste the `credentials.json.tpl` file to `credentials.json` and file your username and password.
 3. Run `python -m finary_uapi signin`
 4. You are good to go and can explore the API. Run `python -m finary_uapi` for available commands.
@@ -119,3 +119,32 @@ python -m finary_uapi dashboard gross all | jq '.result["total"]["amount"]'
 ### Remarks for finary devs
 * Delete responses should be normalized, sometimes we get json back sometimes nothing but the 204 HTTP code.
 
+
+
+## Contributors ✨
+
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
+Thanks go to these people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="16.66%"><a href="http://lasconic.com"><img src="https://avatars.githubusercontent.com/u/234271?v=4?s=100" width="100px;" alt="Nicolas Froment"/><br /><sub><b>Nicolas Froment</b></sub></a><br /><a href="#projectManagement-lasconic" title="Project Management">📆</a> <a href="#promotion-lasconic" title="Promotion">📣</a> <a href="https://github.com/lasconic/finary_uapi/commits?author=lasconic" title="Code">💻</a> <a href="https://github.com/lasconic/finary_uapi/issues?q=author%3Alasconic" title="Bug reports">🐛</a> <a href="#ideas-lasconic" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/lasconic/finary_uapi/commits?author=lasconic" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="16.66%"><a href="http://varal7.fr"><img src="https://avatars.githubusercontent.com/u/8019486?v=4?s=100" width="100px;" alt="Victor Quach"/><br /><sub><b>Victor Quach</b></sub></a><br /><a href="https://github.com/lasconic/finary_uapi/commits?author=Varal7" title="Code">💻</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

finary_uapi-0.1.4/finary_uapi/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Getting started
+
+1. Install [`poetry`](https://python-poetry.org/) which manages the project dependencies, and get all dependencies needed to work on this project:
+```sh
+pip3 install poetry && poetry check && poetry install
+```
+2. Use `./check.sh` to check the syntax, reindent and code guidelines
+3. Run tests with 
+```sh
+poetry run pytest
+```

{finary_uapi-0.1.2 → finary_uapi-0.1.4}/finary_uapi/__init__.py

@@ -7,7 +7,7 @@ You can always get the latest version of this module at:
     https://github.com/lasconic/finary-uapi
 """
 
-__version__ = "0.1.2"
+__version__ = "0.1.4"
 __author__ = "lasconic"
 __copyright__ = """
 Copyright (c) 2021-2022, lasconic

{finary_uapi-0.1.2 → finary_uapi-0.1.4}/finary_uapi/__main__.py

@@ -17,6 +17,7 @@ Usage:
     finary_uapi real_estates [all | 1w | 1m | ytd | 1y]
     finary_uapi startups
     finary_uapi investments
+    finary_uapi investments dividends
     finary_uapi crowdlendings
     finary_uapi crowdlendings distribution
     finary_uapi cryptos
@@ -58,6 +59,8 @@ Usage:
     finary_uapi import crypto_csv FILENAME [(--new=NAME | --edit=account_id | --add=account_id)]
     finary_uapi import stocks_csv FILENAME [(--new=NAME | --edit=account_id | --add=account_id)] [-d]
     finary_uapi import stocks_json FILENAME [(--new=NAME | --edit=account_id | --add=account_id)] [-d]
+    finary_uapi sharing SHARING_CODE_OR_URL [--secret=SECRET_CODE]
+
 
 Options:
   --new=NAME          Create a new account and import the lines
@@ -86,10 +89,11 @@ from .importers.crypto_generic_csv import import_crypto_generic_csv
 from .importers.stocks_generic_csv import import_stocks_generic_csv
 from .institutions import get_institutions
 from .user_portfolio import (
-    get_portfolio_cryptos_distribution,
     get_portfolio_investments,
+    get_portfolio_investments_dividends,
     get_portfolio_crowdlendings,
     get_portfolio_crowdlendings_distribution,
+    get_portfolio_cryptos_distribution,
 )
 from .precious_metals import get_precious_metals
 from .user_generic_assets import (
@@ -102,6 +106,7 @@ from .user_real_estates import get_user_real_estates
 from .user_scpis import get_user_scpis
 from .scpis import get_scpis
 from .securities import get_securities
+from .sharing import get_sharing
 from .signin import signin
 from .user_startups import get_user_startups
 from .user_cryptos import (
@@ -295,7 +300,10 @@ def main() -> int:  # pragma: nocover
             else:
                 result = get_user_cryptos(session)
         elif args["investments"]:
-            result = get_portfolio_investments(session)
+            if args["dividends"]:
+                result = get_portfolio_investments_dividends(session)
+            else:
+                result = get_portfolio_investments(session)
         elif args["holdings_accounts"]:
             if args["<account_name>"]:
                 result = get_holdings_account_per_name_or_id(
@@ -391,6 +399,8 @@ def main() -> int:  # pragma: nocover
                         add_imported_securities_to_account(
                             session, args["--add"], to_be_imported, dry_run=args["-d"]
                         )
+        elif args["sharing"]:
+            result = get_sharing(args["SHARING_CODE_OR_URL"], args["--secret"] or "")
     if result:
         print(json.dumps(result, indent=4))
 

{finary_uapi-0.1.2 → finary_uapi-0.1.4}/finary_uapi/currencies.py

@@ -20,6 +20,7 @@ def get_currencies(session: requests.Session, type: str, query: str):
     return x.json()
 
 
+# utils functions
 def get_cryptocurrency_by_code(session: requests.Session, code: str):
     currencies = get_currencies(session, "crypto", code)
     if len(currencies["result"]) > 0:

{finary_uapi-0.1.2 → finary_uapi-0.1.4}/finary_uapi/securities.py

@@ -16,7 +16,9 @@ def get_securities(session: requests.Session, query):
         logging.debug(json.dumps(x.json(), indent=4))
         result = x.json()
     else:
-        logging.warn(f"Error searching for [{query}]. Status code = [{x.status_code}]")
+        logging.warning(
+            f"Error searching for [{query}]. Status code = [{x.status_code}]"
+        )
         result = {"result": []}
     return result
 

finary_uapi-0.1.4/finary_uapi/sharing.py

@@ -0,0 +1,25 @@
+import json
+import logging
+import requests
+from typing import Any
+
+from .constants import API_ROOT
+
+
+def get_sharing(sharing_code_url: str = "", secret_code: str = "") -> Any:
+    sharing_code = sharing_code_url.strip()
+    if sharing_code.startswith("http"):
+        s_array = sharing_code.split("/")
+        if "share" in s_array:
+            sharing_code = s_array[s_array.index("share") + 1]
+    if not sharing_code.isalnum():
+        logging.debug("sharing code is not well formatted")
+        return {}
+    sharing_url = f"{API_ROOT}/sharing/{sharing_code}"
+    session = requests.Session()
+    params = {}
+    if secret_code:
+        params["code"] = secret_code
+    x = session.get(sharing_url, params=params)
+    logging.debug(json.dumps(x.json(), indent=4))
+    return x.json()

{finary_uapi-0.1.2 → finary_uapi-0.1.4}/finary_uapi/user_me.py

@@ -13,3 +13,13 @@ def get_user_me(session: requests.Session) -> Any:
 def get_user_me_institution_connections(session: requests.Session) -> Any:
     url = f"{API_ROOT}/users/me/institution_connections/details"
     return get_and_print(session, url)
+
+
+def get_user_me_sharing_links(session: requests.Session) -> Any:
+    url = f"{API_ROOT}/users/me/sharing_links"
+    return get_and_print(session, url)
+
+
+def get_user_me_subscription_details(session: requests.Session) -> Any:
+    url = f"{API_ROOT}/users/me/subscription_details"
+    return get_and_print(session, url)

{finary_uapi-0.1.2 → finary_uapi-0.1.4}/finary_uapi/user_portfolio.py

@@ -66,3 +66,9 @@ def get_portfolio_distribution(
     x = session.get(url, params=params)
     logging.debug(json.dumps(x.json(), indent=4))
     return x.json()
+
+
+def get_portfolio_investments_dividends(session: requests.Session):
+    portfolio_type = "investments"
+    url = f"{portfolio_api}/{portfolio_type}/dividends"
+    return get_and_print(session, url)

{finary_uapi-0.1.2 → finary_uapi-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "finary-uapi"
-version = "0.1.2"
+version = "0.1.4"
 description = "Finary API client and command line tool to interact with your Finary account."
 authors = ["lasconic <lasconic@gmail.com>"]
 license = "MIT License"
@@ -20,10 +20,10 @@ mypy = "1.3.0"
 pdoc3 = "0.10.0"
 pydocstyle = "6.3.0"
 pytest = "7.3.1"
-pytest-cov = "4.0.0"
+pytest-cov = "4.1.0"
 pytest-dependency = "0.5.1"
 responses = "0.23.1"
-types-requests = "2.30.0.0"
+types-requests = "2.31.0.1"
 
 [build-system]
 requires = ["poetry-core"]