---
id: mattermostwrapper
version: "2.2"
license: MIT
license_treatment: permissive
maintenance: abandoned
---

# mattermostwrapper — A mattermost api v4 wrapper to interact with api

License: permissive · Maintenance: abandoned · Downloads: 241.0K/mo

## What it is and what it does

mattermostwrapper is a thin Python client for the Mattermost v4 REST API. It handles authentication and provides methods to query teams, list channels, and post messages to a Mattermost server. The package was designed primarily for bot automation and scripting tasks that need to interact with Mattermost programmatically.

The wrapper is lightweight—it has no external runtime dependencies—and exposes the Mattermost API through simple Python methods. However, the project has been abandoned since early 2020, with no commits or releases in over four years. This means it may not be compatible with recent Mattermost versions, newer Python releases, or current security practices, and you should verify compatibility with your specific Mattermost deployment before relying on it for production use.

Use it for:

- Build a bot that automatically posts notifications or alerts to Mattermost channels
- Retrieve team and channel information from Mattermost for reporting or integration purposes
- Automate message posting to specific channels as part of a larger workflow or monitoring system
- Script one-off administrative tasks like bulk channel queries or message archival

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

A Python wrapper for the Mattermost v4 API that lets you authenticate with a Mattermost server and perform operations like retrieving teams, listing channels, and posting messages programmatically.

No, unless you are maintaining legacy code already using this package. The project is abandoned (last commit 2020-02-18), making compatibility with current Mattermost versions and Python environments highly uncertain. Before installing, verify that it works with your Mattermost version and check whether an actively maintained alternative exists. The permissive MIT license removes legal friction, but technical risk is substantial.

## Install

pip install mattermostwrapper
uv add mattermostwrapper
poetry add mattermostwrapper

## Installing mattermostwrapper

Before you install: Installation friction is high and maintenance is a concern: the package was last updated on 2020-02-17 and has not received commits since then, with the repository marked as abandoned. It has no runtime dependencies, but the lack of recent activity means compatibility with current Mattermost versions and modern Python environments is uncertain.

License in practice: Licensed under MIT (permissive), so you can use, modify, and distribute the package freely with minimal restrictions, though you should retain the license notice.

Quickstart:

pip install mattermostwrapper

from mattermostwrapper import MattermostAPI

m = MattermostAPI("https://yoururlhere/api/v4")
m.login("username", "password")
channel_list = m.get_channel_listing('team_name')
for channel in channel_list:
    print(channel['display_name'])

Requires a running Mattermost server with v4 API available and valid credentials; no Python version requirement is specified in the package metadata.

Verify before relying:

- Whether the package works with current Mattermost API versions beyond v4 or with modern Python releases
- Current state of the documentation at the referenced readthedocs URL
- Whether the package has been superseded by an official or actively maintained Mattermost Python client

## Package facts

- License: MIT (permissive)
- Python support: unspecified
- Install friction: high
- Maintenance: abandoned
- Downloads: 241.0K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

mattermost api wrapper, mattermost bot client, mattermost channel management, mattermost message posting, mattermost python client, mattermost api v4, mattermost automation, abandoned, mattermost-integration

[View on SkillFed](https://skillfed.io/packages/mattermostwrapper) · [View on PyPI](https://pypi.org/project/mattermostwrapper/)