mirror of
https://github.com/dtomlinson91/panaetius.git
synced 2025-12-22 13:05:45 +00:00
updating documentation
This commit is contained in:
@@ -3,19 +3,46 @@
|
||||
panaetius :modname:`panaetius`
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: panaetius
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
API
|
||||
---
|
||||
===
|
||||
|
||||
The following is availble by importing the module:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import panaetius
|
||||
|
||||
:func:`panaetius.library.set_config`
|
||||
import panaetius
|
||||
|
||||
|
||||
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