updating documentation

This commit is contained in:
2020-01-13 22:18:59 +00:00
parent 8e6af58da9
commit 0b1abf6bf5

View File

@@ -3,14 +3,9 @@
panaetius :modname:`panaetius` panaetius :modname:`panaetius`
------------------------------------- -------------------------------------
.. automodule:: panaetius
:members:
:undoc-members:
:show-inheritance:
API API
--- ===
The following is availble by importing the module: The following is availble by importing the module:
@@ -18,4 +13,36 @@ The following is availble by importing the module:
import panaetius import panaetius
:func:`panaetius.library.set_config`
panaetius.CONFIG
----------------
``panaetius.CONFIG`` provides an instance of :class:`panaetius,config.Config`
panaetius.set_config()
-----------------------
Conveniently provides :func:`panaetius.library.set_config`
Use in your module/script with:
.. code-block:: python
panaetius.set_config(panaetius.CONFIG, 'aws.secret_key', str, mask=True)
panaetius.CONFIG.aws_secret_key
-------------------------------
Conveniently provides access to all attributes that have been declared with :func:`panaetius.library.set_config`:
.. code-block:: python
panaetius.CONFIG.aws_secret_key
panaetius.logger
-----------------
``panaetius.logger`` provides a logger instance already formatted with a nice json output.