From 4d6f8dcc6db326772567c21d5586b6d703523a5c Mon Sep 17 00:00:00 2001 From: Paco Hope Date: Sun, 4 Dec 2022 11:28:44 -0500 Subject: [PATCH] Added more docs --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 1acd024..9bea62a 100644 --- a/README.md +++ b/README.md @@ -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()](https://docs.python.org/3/library/random.html#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,