mattermostdriver

What it is and what it does

Mattermostdriver is a Python client for the Mattermost messaging platform's REST API (v4). It wraps HTTP requests and WebSocket connections to let you programmatically interact with Mattermost servers—creating channels, posting messages, uploading files, managing users and teams, and listening to real-time events. The library handles authentication via login credentials, personal access tokens, or custom auth headers, and provides a straightforward object-oriented interface where API endpoints map directly to driver methods (e.g., `driver.users.get_user()`, `driver.channels.create_channel()`).

The package depends on websockets and requests for its core functionality. It supports Python 3.5 through 3.9 and is marked as Production/Stable in its classifiers. However, the repository is now archived and abandoned—the last release was in January 2022, with no commits or maintenance since then. This means the package will not receive updates for new Mattermost API changes, security patches, or compatibility fixes for newer Python versions.

Use it for:

• Build bots or automation scripts that monitor Mattermost channels and respond to messages or events in real time
• Integrate Mattermost with external systems by programmatically creating posts, channels, or managing team membership
• Bulk upload files to Mattermost channels or automate file management workflows
• Develop custom Mattermost clients or dashboards that query user, team, or channel data via the API
• Create webhooks or event handlers that react to Mattermost activities without manual intervention

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Python client library for the Mattermost API (v4) that provides programmatic access to users, teams, channels, posts, files, and webhooks via HTTP and WebSocket connections.

No, not recommended for new projects. While the package is stable and has low install friction, it is archived and abandoned with no maintenance since January 2022. Any future changes to the Mattermost API, security vulnerabilities, or Python compatibility issues will go unaddressed. Use only if you are maintaining legacy code already tied to this library and cannot migrate to an actively maintained alternative.

Install

mattermostdriver on PyPI

pip install mattermostdriver

uv add mattermostdriver

poetry add mattermostdriver

Installing mattermostdriver

Before you install

Low install friction with only two runtime dependencies (websockets and requests). However, the package is archived and abandoned—last release was 2022-01-21, over 1666 days ago. No active maintenance or security updates are being provided.

License in practice

Licensed under MIT (permissive), so you can use, modify, and distribute the package freely with minimal restrictions, though you must include the license notice.

Quickstart

pip install mattermostdriver

from mattermostdriver import Driver

driver = Driver({
    'url': 'mattermost.server.com',
    'login_id': 'user.name',
    'password': 'password'
})
driver.login()
user = driver.users.get_user_by_username('another.name')

Requires Python 3.5 or later. Mattermost server must be accessible at the configured URL with valid credentials or a personal access token.

Verify before relying

• Whether the package remains compatible with current Mattermost server versions given the lack of recent updates
• Whether websocket keepalive and reconnection features work reliably in production environments
• Current status of the official Mattermost API—whether v4 is still the current version or if newer versions exist

Package facts

Evidence: mattermostdriver-7.3.2-py3-none-any.whl

Tags

More WWW/HTTP packages