Auto readme

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Jon Michael Aanes
+Copyright (c) 2024 Jon Michael Aanes
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,4 +1,8 @@
-# Personal Data Fetcher Systems
+<!---                   WARNING                    --->
+<!---        THIS IS AN AUTO-GENERATED FILE        --->
+<!---  MANUAL CHANGES CAN AND WILL BE OVERWRITTEN  --->
+
+# Personal Data Fetcher Systems.
 
 This is a collection of small fetchers for personal data spread around the internet.
 
@@ -25,6 +29,29 @@ python -m personal_data
 - [ ]  [WaniKani](https://docs.api.wanikani.com)
 - [ ] Ledger (Live?) Account Balances
 
-## License
 
-This project is licensed under MIT Licence, see LICENSE for full text.
+# License
+
+```
+MIT License
+
+Copyright (c) 2024 Jon Michael Aanes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```

personal_data/__init__.py

@@ -1 +1,29 @@
+"""# Personal Data Fetcher Systems.
+
+This is a collection of small fetchers for personal data spread around the internet.
+
+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))
+
+## Usage
+
+```sh
+python -m personal_data
+```
+
+## Ideas for more fetchers
+
+- [ ] YouTube (Music): Liked videos with title and URL.
+- [ ] Steam Wishlist and Achievements
+- [ ] fredagscafeen.dk
+- [ ]  [WaniKani](https://docs.api.wanikani.com)
+- [ ] Ledger (Live?) Account Balances
+"""
+
 from ._version import __version__  # noqa:F401

setup.py

@@ -11,7 +11,7 @@ from setuptools import setup
 PACKAGE_NAME = 'personal_data'
 
 PACKAGE_DESCRIPTION = """
-# Personal Data Fetcher Systems
+# Personal Data Fetcher Systems.
 
 This is a collection of small fetchers for personal data spread around the internet.
 
@@ -38,9 +38,32 @@ python -m personal_data
 - [ ]  [WaniKani](https://docs.api.wanikani.com)
 - [ ] Ledger (Live?) Account Balances
 
-## License
 
-This project is licensed under MIT Licence, see LICENSE for full text."""
+# License
+
+```
+MIT License
+
+Copyright (c) 2024 Jon Michael Aanes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```"""
 
 PACKAGE_DESCRIPTION_SHORT='This is a collection of small fetchers for personal data spread around the internet.'
 
@@ -76,12 +99,10 @@ frozendict
 python-kucoin
 krakenex
 fin-depo @ git+https://gitfub.space/Jmaa/fin-depo.git
-secret_loader @ https://gitfub.space/Jmaa/secret_loader
+secret_loader @ https://gitfub.space/Jmaa/secret_loader"""
-"""
 
 REQUIREMENTS_TEST = """
-pytest
+pytest"""
-"""
 
 
 setup(
@@ -90,7 +111,7 @@ setup(
     description=PACKAGE_DESCRIPTION_SHORT,
     long_description=PACKAGE_DESCRIPTION,
     long_description_content_type='text/markdown',
-    author='Jmaa',
+    author='Jon Michael Aanes',
     author_email='jonjmaa@gmail.com',
     url='https://gitfub.space/Jmaa/' + PACKAGE_NAME,
     packages=[PACKAGE_NAME],