For my project, I extensively documented Stellar's Python SDK:
https://github.com/StellarCN/py-stellar-base/pull/87
My hope is that this will make the Stellar SDK for Python much easier to understand (not only from its Quickstart and Install guides, but also its complete API documentation), and will make it a lot easier for contributors to continue to make its public API even better. Hopefully by the cutoff it will be hosted on Read The Docs, which will allow the docs to be linked out on PyPi, Github, and hopefully Stellar's official documentation.
Details:
- Added API documentation to most public API's (base58 and utils excluded) on all public methods
- Generated API documentation using Sphinx autodoc, and built out an install guide, quickstart based on the README, along with the API docs.
- Added Pipfile and Pipfile.lock for installation via pipenv, which is becoming recommended practice for Python
- Refactored horizon.py to use request sessions, and cleaned up the overall API.
- Cleaned up exception hierarchy - there's still plenty to do there throughout the codebase, but it's a start.
- Cleaned up numerous linter errors, and added TODO's and FIXME's throughout for additional work.
