diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst index b9f0054..2a04a36 100644 --- a/docs/source/configuration.rst +++ b/docs/source/configuration.rst @@ -3,7 +3,7 @@ Configuration panaetius is fairly easy to configure. There are just a couple of options to be aware of. -header.py +__header__.py ---------- You should set a ``__header__.py`` next to your script or module. @@ -16,6 +16,25 @@ E.g a ``__header__.py`` for the module ``plex_posters`` would look like: __header__ = 'plex_posters' +Your config file can then be created at ``~/.config/__header__/config.toml``. + +Your environment variables can be created with: + +.. code-block:: bash + + HEADER_FOO = "bar" + HEADER_SUBSECTION_FOO = "bar" + +The headers of the toml file would look like: + +.. code-block:: toml + + [__header__] + foo = bar + + [__header__.subsection] + foo = bar + If you are writing a script, simply place this ``__header__.py`` along side your script. Panaetius will pick this up when the script is ran. If you are writing a module, you can either place the ``__header__.py`` alongside the script that uses your module. If this is not possible, panaetius will set the default ``__header__`` variable to the name of the virtualenv that the script is activated from. diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index c892d20..e016cde 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -1,5 +1,5 @@ -panaetius -========== +Introduction +============= .. image:: https://img.shields.io/readthedocs/panaetius?style=for-the-badge :target: https://panaetius.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status diff --git a/src/panaetius/__version__.py b/src/panaetius/__version__.py index cd7ca49..a6221b3 100644 --- a/src/panaetius/__version__.py +++ b/src/panaetius/__version__.py @@ -1 +1 @@ -__version__ = '1.0.1' +__version__ = '1.0.2'