Backup before formatting

2024-11-23 19:56:52 +01:00
parent 9084ab596d
commit 6a1233fc5c
16 changed files with 157 additions and 59 deletions
@@ -16,8 +16,32 @@ Requires-Dist: matplotlib>=3.9.2
 ## About

 Simple project to determine health of the devrant platform.
+Also, it will generate a dataset to be used with machine learning.
+Make Retoor9b great again!

 ## Credits
 Thanks to Rohan Burke (coolq). The creator of the dr api wrapper this project uses. Since it isn't made like a package, i had to copy his source files to my source folder. His library: https://github.com/coolq1000/devrant-python-api/


+## Using this project
+
+### Prepare environment
+Create python3 environment:
+```
+python3 -m venv ./venv
+```
+Activate python3 environment:
+```
+source ./venv/bin/activate
+```
+### Make
+You don't have to use more than make. If you just run `make` all statistics will be generated. It will execute the right apps for generating statistics.
+### Applications
+If you type `dr.` in terminal and press tab you'll see all available apps auto completed. These applications are also used by make.
+```
+1. `dr.sync` synchronizes all data from last two weeks from devrant. Only two weeks because it's rate limited.
+2. `dr.dataset` exports all data to be used for LLM embedding., don't forget to execute `dr.sync` first.
+3. `dr.rant_stats_all` exports all graphs to export folder, don't forget to execute `dr.sync` first.
+4. dr.rant_stats_per_day` exports graphs to export folder. don't forget to execute `dr.sync` first.
+5.dr.rant_stats_per_hour` exports graphs to export folder. don't forget to execute `dr.sync` first.
+6. dr.rant_stats_per_weekday` exports graphs to export folder. don't forget to execute `dr.sync` first.
@@ -3,8 +3,11 @@ pyproject.toml
 setup.cfg
 src/drstats/__init__.py
 src/drstats/__main__.py
+src/drstats/dataset.py
 src/drstats/db.py
 src/drstats/devrant.py
+src/drstats/dump_text.py
+src/drstats/duration.py
 src/drstats/statistics.py
 src/drstats/sync.py
 src/drstats.egg-info/PKG-INFO
@@ -1,4 +1,5 @@
 [console_scripts]
+dr.dataset = drstats.dataset:dump
 dr.rant_stats_all = drstats.statistics:rant_stats_all
 dr.rant_stats_per_day = drstats.statistics:rant_stats_per_day
 dr.rant_stats_per_hour = drstats.statistics:rant_stats_per_hour