Example INI File¶
This is an example configuration file for Mastoscore. It shows all available options with example values and explanations.
I do what is called ExtendedInterpolation in the ini file. This means that you can refer to the value of one variable in the value of another. That's why you see something like ${mastoscore:event_year}-${mastoscore:event_month}-${mastoscore:event_day} in the value of graph:graph_title.
[mastoscore]
episode_title = That Movie we Watched (1999)
event_year = 2026
event_month = 02
event_day = 22
event_start = 2026-02-22T21:00:00-05:00
event_duration = 1:23:32
api_base_url = https://example.com
cred_file = .env/example-creds.env
dry_run = False
event_title = Monsterdon
hashtag = monsterdon
journaldir = data
journalfile = ${mastoscore:hashtag}
tag_users = False
timezone = America/New_York
top_n = 3
[analyse]
hours_margin = 2
[fetch]
max = 100
parallel_workers = 10
[graph]
end_label = ${mastoscore:episode_title} End
graph_title = ${mastoscore:event_title}
${mastoscore:event_year}-${mastoscore:event_month}-${mastoscore:event_day}
${mastoscore:episode_title}
start_label = ${mastoscore:episode_title} Start
[post]
root_visibility = public
tag_users = False
thread_visibility = unlisted
[wordcloud]
fonts = /usr/share/fonts/opentype/HeberlingCasualNF.otf, /usr/share/fonts/opentype/SpeedballNo1NF.otf, /usr/share/fonts/opentype/ClevelandLithoNF.otf
hashtag_fix = remove
size_x = 1280
size_y = 960
stop_words = movie, movies, film, films, watch, now, one, guy,
got, going, good, well, see, know
Directory Structure¶
With this configuration, Mastoscore will organize files as follows:
Journal Files¶
These files contain the raw posts. You could theoretically reprocess them. Generally speaking, mastoscore won't overwrite these files if it finds them. You can use the overwrite parameter in the fetch section of the INI to force overwriting.
When the fetch is done, it will write fetch metadata to a data-myhashtag-fetch.json file. When the analysis is done, it will write the analysis data to a data-myhashtag-analysis.json file.
The directory structure looks like this.
data/
├── 2025/
│ ├── 04/
│ │ ├── 15/
│ │ │ ├── myhashtag-example.social.json
│ │ │ ├── myhashtag-other.social.json
│ │ │ ├── data-myhashtag-analysis.json
│ │ │ ├── data-myhashtag-fetch.json
│ │ │ └── ...
Graph files¶
For now, the histogram is graph and the wordcloud is wordcloud. When the graphs are generated, they generate an image, and a text file with the same prefix. The wordcloud is a little awkward because I implemented 3 different ways of handling the hashtag (see the wordcloud module for more info). I, personally, never use 2 of them. I only ever use the remove option. So the files look like this:
data/
├── 2025/
│ ├── 04/
│ │ ├── 15/
│ │ │ ├── graph-myhashtag-20250415.png # histogram
│ │ │ ├── graph-myhashtag-20250415.txt # histogram alt text
│ │ │ ├── wordcloud-myhashtag-20250415-remove.png # wordcloud
│ │ │ ├── wordcloud-myhashtag-20250415-remove.txt # wordcloud alt text
│ │ │ └── ...
For more details on configuration options, see the config module documentation.