Added more docs

Paco Hope 2022-12-04 11:28:44 -05:00
parent 65c09345e4
commit 4d6f8dcc6d
1 changed files with 25 additions and 0 deletions

View File

@ -47,9 +47,34 @@ You need to run this in a location that can make API calls to your mastodon inst
Assuming everything is up to date, all your files initialised with correct values, you can just run `tootapalooza --once users.toml`. Every user in your `users.toml` file will pick a random action and do one random action.
## Typical usage
For now, the only thing to do that makes sense is to run it with the `--once` flag. We will turn it into a daemon soon.
tootapalooza --once users.toml
### More info
If you want to see what it does, just add the `-d` or `--debug` flag to it.
tootapalooza --once --debug users.toml
### Dry Run
If you give the `-n` or `--dry-run` flag, it _will still login_ as various users. But it will not make any changes. For example, it will read the timelines, or it will pick a post that it wants to reply to. But it will not post the reply, and it won't update the read markers on the public timeline.
tootapalooza --dry-run --once --debug users.toml
## Weights and random actions
If you look in the `random_interactions()` method, you'll see a table of weights. (Example shown below). Those weights are fed into Python's [random.choices()]( function and that's how it picks the actions to take. In the example below, the weights sum to 33. `unfollow_random()` has a weight of 1, so it has a 1 in 33 (3%) chance of happening. Whereas `reply_random_local` has a weight of 4, so it has a 4 in 33 (12%) chance of happening. Adjust the weights to get the blend of traffic you want. If you don't want an action to happen at all, set its weight to 0.
interactions = {
self.reply_random_local: 4,