My Python library for interfacing with Troy Hunt'sHave I Been Pwned API is now in version 0.5.0 and supporting Python 3.5 as well. However, there's surely more to improve on that. Go check the issues or stumble down the source code path. This is a very small library offering all the easy Hacktoberfest points! 🎃
For newcomers I have tasty treats in form of documentation:
This is a no-brainer. We need to have basic documentation about how to install, use, and develop this project.
I have set up a Read the Docs project on #12 which should help to get things going. The rendering is done by mkdocs so Markdown is the way to go.
Any volunteers for writing this? It's recommended to get a good look on library before writing. Also, there will be a CLI implementation done in #10 so it needs to be documented as well.
Should the integration examples under examples directory and referenced in #3 also be moved to documentation? I see no motives against it
Following code snippet should be added to README.md along with link to the actual documentation.
If you have integrated PwnedAPI with eg. Flask, Django, Falcon, or any other cool web framework I'd fancy to see your integration!
Tutorial-level Markdown files (README.md) should be placed in examples directory with relevant code snippets for each framework. Optimal use case would be a sign-up form where the user types their password and has it checked against with PwnedAPI.
My Python library for interfacing with Troy Hunt's Have I Been Pwned API is now in version 0.5.0 and supporting Python 3.5 as well. However, there's surely more to improve on that. Go check the issues or stumble down the source code path. This is a very small library offering all the easy Hacktoberfest points! 🎃
For newcomers I have tasty treats in form of documentation:
This is a no-brainer. We need to have basic documentation about how to install, use, and develop this project.
I have set up a Read the Docs project on #12 which should help to get things going. The rendering is done by
mkdocsso Markdown is the way to go.Any volunteers for writing this? It's recommended to get a good look on library before writing. Also, there will be a CLI implementation done in #10 so it needs to be documented as well.
Should the integration examples under
examplesdirectory and referenced in #3 also be moved to documentation? I see no motives against itFollowing code snippet should be added to README.md along with link to the actual documentation.
...improving code quality as reported by Codacy:
We are using Codacy to monitor code quality and security issues. Its grade is now
CB so there's some room for improvement.Anyone willing to fix those? Discuss here if some rules need ignoring or adjustment.
...or if you want to integrate with your favorite web framework, please tell me how it went:
If you have integrated PwnedAPI with eg. Flask, Django, Falcon, or any other cool web framework I'd fancy to see your integration!
Tutorial-level Markdown files (README.md) should be placed in
examplesdirectory with relevant code snippets for each framework. Optimal use case would be a sign-up form where the user types their password and has it checked against with PwnedAPI.Frameworks covered