Reference Package: A basic package template¶
Includes typical CLI and library setup. To include service app setup at some point.
See also the GitHub repository: https://github.com/crickets-and-comb/reference_package
This is a Crickets and Comb resource.
Contents¶
Installation¶
To install the package, run:
pip install reference_package
Library¶
Avoid calling library functions directly and stick to the public API:
from reference_package import wait_a_second
wait_a_second()
If you’re a power user, you can use the internal API:
from reference_package.api.internal import wait_a_second
wait_a_second()
Nothing is stopping you from importing from lib directly, but you should avoid it unless you’re developing:
from reference_package.lib.example import wait_a_second
wait_a_second()
CLI¶
When this package is installed, it comes with CLI tools. See CLI for more information.