mirror of
https://github.com/dtomlinson91/panaetius.git
synced 2025-12-22 04:55:44 +00:00
updating documentation
This commit is contained in:
@@ -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.
|
||||||
|
|||||||
Reference in New Issue
Block a user