mastodon-mock 0.0.1

Stateful in-memory/SQLite mock of the Mastodon REST API for testing Mastodon clients

Mastodon Mock

mastodon_mock is a stateful, in-process mock of the Mastodon REST API. It runs a real FastAPI server backed by a minimal in-memory (or on-disk) SQLite database, so client code — including Mastodon.py — can post statuses, follow accounts, build timelines, manage lists and filters, and exercise OAuth flows against a fast, deterministic, side-effect-free target. It is intended for testing and local development where talking to a live Mastodon instance is slow, flaky, or undesirable.

Installation

pipx install mastodon_mock

Or with pip:

pip install mastodon_mock

Usage

Run the mock server:

mastodon_mock serve --in-memory

Useful flags:

• serve --config PATH — load configuration from a .mastodon_mock.toml file.
• serve --host HOST --port PORT — override the bind address.
• serve --in-memory — force an ephemeral in-memory SQLite database.
• db upgrade — run Alembic migrations to bring an on-disk database to head.

Point a client at it (for example, with Mastodon.py):

from mastodon import Mastodon

client = Mastodon(access_token="alice_token", api_base_url="http://127.0.0.1:8000")
client.status_post("hello from a mock!")

See mastodon_mock --help for the full command reference.

Configuration

Configuration is resolved in this order: an explicit --config path (or ./.mastodon_mock.toml), then a [tool.mastodon_mock] table in ./pyproject.toml, then built-in defaults. See https://github.com/matthewdeanmartin/mastodon_mock/blob/main/docs/overview/README.md for details.

Contributing

See CONTRIBUTING.md.

License

MIT — see LICENSE.

Changelog

docs/overview/README.md See CHANGELOG.md.