dtomlinson/panaetius
1
0
Fork 0
mirror of https://github.com/dtomlinson91/panaetius.git synced 2025-12-22 04:55:44 +00:00
Code Issues Projects Releases Wiki Activity

updating documentation

Browse Source
This commit is contained in:
dtomlinson
2020-01-14 00:06:59 +00:00
parent 530f3b49ff
commit 064aec1e89
4 changed files with 49 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/source/configuration.rst
View File

@@ -1,4 +1,23 @@
Configuration
=============
.. todo:: fill in configuration options
panaetius is fairly easy to configure. There are just a couple of options to be aware of.
header.py
----------
You should set a ``__header__.py`` next to your script or module.
This ``__header__.py`` should contain a ``__header__`` variable that sets the name of your project/script.
E.g a ``__header__.py`` for the module ``plex_posters`` would look like:
.. code-block:: python
__header__ = 'plex_posters'
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.
If neither of the above aren't possible (say your script is running in a lambda on AWS), then ``__header__`` will be set to the default of ``panaetius``.