Write Documentation for Python Packages Using Sphinx
Things on this page are fragmentary and immature notes/thoughts of the author. Please read with your own judgement!
Installation
You can install Sphinx and necessary extensions using the following command.
pip3 install sphinx sphinx-autodoc-typehints
Or simply
xinstall sphinx -ic
Since the above commands installs Sphinx to the user's local …
Hands on Dulwich
Note: dulwich is not feature complete yet and the development of the project is extremely slow. It is suggested that you use other Python packages instead. For more discussions, please refer to Git Implementations and Bindings in Python .
Tips and Traps¶
- The
gitcommand (and thus Dulwich) accepts URLs both with and without the trailing.git
Hands on GitPython
Tips and Traps¶
GitPython is a wrapper around the
gitcommand. It requires thegitcommand to be on the search path in order to work. Also, sometimes it is easier to call thegitcommand viasubprocess.rundirectly instead of using GitPython.The
gitcommand (and thus GitPython) accepts URLs both with and without the trailing.git
Check Whether a File Is a Text File in Python
python-magic¶
python-magic is the recommended library to use for checking whether a file is a text file.
Messsage Queue Implementations
Things on this page are fragmentary and immature notes/thoughts of the author. Please read with your own judgement!
Kafka seems to be the most popular message queue currently. Redis and memcached are more suitaable for situations where you need cache in memory.
Protocols
AMQP is the Advanced Message Queuing …