Metadata-Version: 2.2
Name: mastomsg
Version: 0.1.3
Summary: Tool to help mastodon server admins to conveniently reach certain parts of their user base with DMs.
Author-email: tante <tante@tante.cc>
Project-URL: Homepage, https://codeberg.org/tante/mastomsg
Project-URL: Repository, https://codeberg.org/tante/mastomsg
Project-URL: Issues, https://codeberg.org/tante/mastomsg/issues
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mastodon-py>=1.8.1
Requires-Dist: typer>=0.15.1

# mastomsg

A messanger for admins of mastodon servers allowing them to message groups of users.

You can install it via pip/pipx (requires Python-3.10+):

`pipx install mastomsg`

Then you have access to the command `mastomsg`.

`mastomsg` expects you to pass it a (potentially multi-line) text as it's first argument. The text can contain placeholders for all user account properties you might want.
To use the person's display name you can for example include `{target.display_name}` in your text. You should ideally include "`@{target.username}'" somewhere to create an actual mention.
If your text doesn't include any mentions you will be asked if the system should automatically prepend it. Check out [the Mastodon.py docs](https://mastodonpy.readthedocs.io/en/stable/02_return_values.html#user-account-dicts) to see all possible values.

To select the target audience you can either use `--handles` or `--age`. With `--handles` you just add a list of local usernames separated by , to send the message to.
With `--ages` you supply a time delta (in days or hours) to select all acounts created in that timeframe. Note that for bigger instance this command can be quite slow.

# TODO:
- load message from a text file or STDIN
- add progress bar when sending more than 10 messages
- Allow to customize type of message (currently only DM is supported)
