drstats/README.md

# dRStats

## 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!

Generating these statistics takes quite some steps. Look at the build log under the `actions` tab.

## 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.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.
Initial commit 2024-11-23 18:56:52 +00:00			`# dRStats`

			`## About`

			`Simple project to determine health of the devrant platform.`
Update logging 2024-11-23 19:29:56 +00:00
Backup before formatting 2024-11-23 18:56:52 +00:00			`Also, it will generate a dataset to be used with machine learning.`
Update logging 2024-11-23 19:29:56 +00:00
Backup before formatting 2024-11-23 18:56:52 +00:00			`Make Retoor9b great again!`
Initial commit 2024-11-23 18:56:52 +00:00
Update logging 2024-11-23 19:29:56 +00:00			Generating these statistics takes quite some steps. Look at the build log under the `actions` tab.

Working 2024-11-23 18:56:52 +00:00			`## 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/`

Initial commit 2024-11-23 18:56:52 +00:00
Backup before formatting 2024-11-23 18:56:52 +00:00			`## 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.
Update 2024-11-23 18:56:52 +00:00			3. `dr.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.