Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

A Python Mattermost Driver

Project description


Currently WIP / Unstable Breaking Changes are likely!


pip install mattermostdriver


from mattermostdriver import Driver

foo = Driver({
    # Required options
    'url': '',
    'login_id': '',
    'password': 'verySecret',
    # Optional / defaults to
    'scheme': 'https',
    'port': 8065,
    'basepath': '/api/v4',
    # Use False if self signed/insecure certificate
    'verify': True,
    # The interval the websocket will ping the server to keep the connection alive
    'timeout': 30,

foo.login() # Returns the response

foo.api['users'].get_user_by_username('') # Returns JSON

    'team_id': 'some_team_id',
    'name': 'awesome-channel',
    'display_name': 'awesome channel',
    'type': 'O'


Available endpoints:

  • users
  • teams
  • channels
  • posts
  • files
  • preferences
  • system
  • webhooks
  • commands
  • compliance
  • cluster
  • brand
  • oauth
  • saml
  • ldap
  • jobs

See to see which api requests are available.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
mattermostdriver-0.4.0.tar.gz (9.8 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page