The fish_pen module¶
Fisherman’s Friend, May 20, 2021
This page documents the Python module itself.
This module really only exists to test on and to show off some of the stuff you can do with an incredibly minimal Python module.
This module does absolutely nothing useful. That’s why it’s perfect for demonstrating some of the concepts without getting caught up in all the details of the implementation in Python.
On PyPi | Fork me on GitGud | Read the docs
Installation¶
Installation of the fish_pen modules should be as simple as running:
python3 -m pip install fish_pen
Or if you want to install directly from the wheel from the package:
python3 -m pip install --find-links=/usr/share/wheels fish_pen
Introduction¶
As mentioned above, this module exists purely to act as an example of how you can package things and integrate them into various services. The package itself is intentionally kept very small without any useful functionality, because the Python code isn’t really the relevant part here. It’s the packaging, documentation, CI, etc.
Module reference¶
This module is documented with autodoc. That means if you have docstrings, you don’t have to double up your documentation. Watch:
- fish_pen.hello() → None¶
Print
Hello world!. As simple as it gets.- Returns
None.
This makes it a lot easier to make sure code and documentation is kept in sync.