Data module documented

ciclopibot/__init__.py

@@ -3,6 +3,6 @@
 __author__ = "Davide Testa"
 __email__ = "davide@davte.it"
 __license__ = "GNU General Public License v3.0"
-__version__ = "1.0.0"
+__version__ = "1.0.1"
 __maintainer__ = "Davide Testa"
 __contact__ = "t.me/davte"

ciclopibot/data/__init__.py

@@ -0,0 +1,19 @@
+"""This folder contains user data.
+
+Therefore, it must be .gitignored and excluded from python packaging.
+
+Examples of data files
+- `ciclopi.db`: bot SQLite database file
+- Info and erro logs
+- `config.py`: configuration file providing local host and port where web app
+    should run
+    ```python
+    local_host = '127.0.0.1'
+    port = 8080
+    ```
+- `help.json`: file where /help data are stored
+- `passwords.py`: secret file where you can store your bot token
+    ```python
+    bot_token = "111222333:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
+    ```
+"""