robotooter 0.1.0

A Python framework for easily creating Mastodon bots with pluggable content generation and filtering capabilities

RoboTooter

A Python framework for easily creating Mastodon bots with pluggable content generation and filtering capabilities.

Features

• Multiple Bot Types: Currently supports Markov chain-based text generation
• Flexible Filtering: Extensible filter system for processing input text (Gutenberg, blank line removal, paragraph combining)
• Mastodon Integration: Built-in support for posting to Mastodon instances
• CLI Interface: Easy-to-use command line interface for bot management
• Configuration Management: Simple bot configuration and data management

Installation

This project uses Poetry for dependency management. To install:

git clone <repository-url>
cd robotooter
poetry install

Quick Start

1. Configure the framework:

   robotooter configure
   

2. Create a new bot:

   robotooter create-bot
   

3. Set up your bot's data (for Markov bots, add a sources.txt file to the bot directory):

   robotooter --bot <bot-name> setup
   

4. Authorize your bot with Mastodon:

   robotooter --bot <bot-name> authorize
   

5. Generate content locally:

   robotooter --bot <bot-name> speak
   

6. Post to Mastodon:

   robotooter --bot <bot-name> toot
   

Bot Types

Markov Bot

The Markov bot generates text using Markov chains trained on source material.

Setup Requirements:

• Create a sources.txt file in your bot's working directory
• Each line should contain a URL to a text file to use as training data
• Run robotooter --bot <bot-name> setup to download and process the sources

CLI Commands

• robotooter info - Display information about the local setup
• robotooter configure - Initialize configuration
• robotooter create-bot - Create a new bot
• robotooter --bot <name> setup - Download and process bot training data
• robotooter --bot <name> authorize [--force] - Authorize bot with Mastodon
• robotooter --bot <name> speak [--count N] - Generate content locally
• robotooter --bot <name> toot - Generate and post content to Mastodon

Project Structure

src/robotooter/
\x00\x00 bots/           # Bot implementations
   \x00\x00 base_bot.py # Base bot class
   \x00\x00 markov/     # Markov chain bot
\x00\x00 cli/            # Command line interface
\x00\x00 filters/        # Text processing filters
\x00\x00 mastodon_manager.py  # Mastodon API integration
\x00\x00 models.py       # Data models
\x00\x00 util.py         # Utility functions

Development

Requirements

• Python 3.12+
• Poetry for dependency management

Development Setup

poetry install --with dev

Running Tests

poetry run pytest

Code Quality

The project uses Ruff for linting and MyPy for type checking:

# Linting
./scripts/lint

# Type checking  
./scripts/type

Dependencies

• requests: HTTP client for downloading source material
• markovify: Markov chain text generation
• mastodon.py: Mastodon API client
• pydantic: Data validation and settings management
• jinja2: Template engine

License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). See the LICENSE file for details.

The AGPL-3.0 is a copyleft license that requires anyone who distributes the code or runs it on a server to make the source code available under the same license terms.