diff --git a/CHANGELOG.txt b/CHANGELOG.txt index e548c53..e6b2131 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -1,14 +1,22 @@ Change Log ========== +0.0.8 (19/03/2022) +------------------- +- Made most funtions `@classmethod`'s so you don't have to init the class +- Updated all doc strings to use `:param` so IDE's show it when typing +- Fixed `import *` to import the actual stuff + +**Not code but the package now has [documentation](https://fusionsid.github.io/FusionSidAPI.py/)** + 0.0.7 (10/03/2022) ------------------- - Added 9 Text convert functions in `fusionsid.Text()` -- Added reddit_search +- Added `reddit_search` 0.0.6 (09/03/2022) ------------------- -- Wordle answer +- Wordle answers 0.0.5 (08/03/2022) ------------------- diff --git a/README.md b/README.md index 3524d3d..4ca1e0f 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,14 @@ pip install fusionsidsapi # Need Help -Even though there is so documentation for this package at the moment, each class and function has a doc string so if you need help with anything in the pacakge just use the built in python function `help()` +### Docs +This package now has [docs](https://fusionsid.github.io/FusionSidAPI.py/) + +https://fusionsid.github.io/FusionSidAPI.py/ +or look in the Enviroments tab + +### Help Function +Each class and function has a doc string so if you need help with anything in the pacakge just use the built in python function `help()` eg: ```py @@ -48,13 +55,28 @@ import asyncio from fusionsid import Fun async def main(): - roast = await Fun().roast() + roast = await Fun.roast() print(roast) loop = asyncio.new_event_loop() loop.run_until_complete(main()) ``` +This package also has some decorators (also in the examples folder) so if you want a complement before your code is run heres how: +```py +import asyncio +from fusionsid import Decorators + +do_compliment = Decorators.compliment + +@do_compliment() +async def main(): + print("Wassup") + +loop = asyncio.new_event_loop() +loop.run_until_complete(main()) +``` + --- ### [FusionSidAPI Github](https://github.com/FusionSid/FusionSidsAPI) @@ -68,3 +90,6 @@ Discord: `FusionSid#3645` ## Changelog: You can checkout the changes per version in [CHANGELOG.txt](https://github.com/FusionSid/FusionSidAPI.py/blob/master/CHANGELOG.txt) + + +If you find a bug please make an issue, I will try my best to fix it :) \ No newline at end of file diff --git a/fusionsid/text.py b/fusionsid/text.py index 5c04c3c..2ad9364 100644 --- a/fusionsid/text.py +++ b/fusionsid/text.py @@ -17,7 +17,7 @@ class Text(): hex_to_text(hex : str) : Converts hex to text - encrypt(text : str) : Encrypts text (Can not be decrypted) + hash(text : str) : Hashes text password(text : str, length : str = None) : Generates a password diff --git a/setup.py b/setup.py index 6daa763..4a12285 100644 --- a/setup.py +++ b/setup.py @@ -21,4 +21,5 @@ # python3 setup.py bdist_wheel # twine upload dist/* +# twine upload --repository-url https://upload.pypi.org/legacy/ dist/* # sudo rm -rf ./build ./dist ./*egg-info \ No newline at end of file