stormwater_monitoring_datasheet_extraction.api package¶
Submodules¶
stormwater_monitoring_datasheet_extraction.api.internal module¶
Internal functions overlay library and are typically wrapped by public functions.
This allows us to maintain a separation of API from implementation. Internal functions may come with extra options that public functions don’t have, say for power users and developers who may want to use an existing DB session or something.
- stormwater_monitoring_datasheet_extraction.api.internal.wait_a_second(seconds=1, extra_string='')¶
Just wait a second, or however many seconds you want.
Also prints a message with the number you passed.
- Parameters:
seconds (
int) – How many seconds to wait.extra_string (
str) – Extra message to add on tail of existing message.
- Return type:
None
stormwater_monitoring_datasheet_extraction.api.public module¶
Public functions wrap internal functions which wrap library functions.
This allows separation of API from implementation. It also allows a simplified public API separate from a more complex internal API with more options for power users.
- stormwater_monitoring_datasheet_extraction.api.public.wait_a_second(seconds=1)¶
Just wait a second, or however many seconds you want.
Also prints a message with the number you passed.
- Parameters:
seconds (
int) – How many seconds to wait.- Return type:
None
Module contents¶
Do not define in API, only import.