From 6027f37c3cf8036a93f6ae1261fea007263a80ed Mon Sep 17 00:00:00 2001 From: Jon Michael Aanes Date: Sun, 21 Jul 2024 14:37:46 +0200 Subject: [PATCH] Extended readme --- personal_data/__init__.py | 26 ++++++++++++++++++-------- personal_data/secrets.py | 2 +- 2 files changed, 19 insertions(+), 9 deletions(-) diff --git a/personal_data/__init__.py b/personal_data/__init__.py index 0739054..ccd9816 100644 --- a/personal_data/__init__.py +++ b/personal_data/__init__.py @@ -1,29 +1,39 @@ """# Personal Data Fetcher Systems. -This is a collection of small fetchers for personal data spread around the internet. +This program collects several small data fetchers, for downloading personal +data spread around the internet. The fetchers are mostly related either to +personal finance, or to various nerdy hobbies. Supported fetchers: - Crunchyroll episode watch history - FFXIV Lodestone achivement history -- Partisia Blockchain BYOC and MPC trackers - Playstation achievements by way of PSN Profiles. -- Kraken Account Balances (Using [API](https://docs.kraken.com/rest/#tag/Account-Data/operation/getAccountBalance)) -- Kucoin Account Balances (Using [API](https://www.kucoin.com/docs/rest/account/basic-info/get-account-list-spot-margin-trade_hf)) +- Account balances for several backends supported by [`fin-depo`](https://gitfub.space/Jmaa/fin-depo) + * Partisia Blockchain BYOC and MPC trackers + * Kraken Account Balances + * Kucoin Account Balances ## Usage +Add relevant secrets to +a [`secret_loader`](https://gitfub.space/Jmaa/secret_loader)-compatible +location, and run: + ```sh python -m personal_data ``` -## Ideas for more fetchers +Use `--help` option to see all options. + +## Further expansion - [ ] YouTube (Music): Liked videos with title and URL. - [ ] Steam Wishlist and Achievements -- [ ] fredagscafeen.dk -- [ ] [WaniKani](https://docs.api.wanikani.com) +- [ ] [WaniKani](https://docs.api.wanikani.com) - [ ] Ledger (Live?) Account Balances """ -from ._version import __version__ # noqa:F401 +__all__ = ['__version__'] + +from ._version import __version__ diff --git a/personal_data/secrets.py b/personal_data/secrets.py index 19967ff..a56c1d5 100644 --- a/personal_data/secrets.py +++ b/personal_data/secrets.py @@ -1,6 +1,6 @@ from secret_loader import SecretLoader -load_secret = SecretLoader(env_key_prefix = 'CF_PD').load +load_secret = SecretLoader(env_key_prefix='CF_PD').load # Crunchyroll CRUNCHYROLL_DEVICE_ID = load_secret('CRUNCHYROLL_DEVICE_ID')