Skip to main content

A Python Mattermost Driver

Project description

Info

Currently WIP / Unstable

Installation

pip install mattermostdriver

Usage

from mattermostdriver import Driver

foo = Driver({
    # Required options
    'url': 'mattermost.server.com',
    'login_id': 'user.name',
    '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('another.name') # Returns JSON

foo.api.channels.create_channel({
    'team_id': 'some_team_id',
    'name': 'awesome-channel',
    'display_name': 'awesome channel',
    'type': 'O'
})

foo.init_websocket(event_handler)

Available endpoints:

  • users

  • teams

  • channels

  • posts

  • files

  • preferences

  • system

  • webhooks

  • commands

  • compliance

  • cluster

  • brand

  • oauth

  • saml

  • ldap

  • jobs

See https://api.mattermost.com/v4/ 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.

Source Distribution

mattermostdriver-0.3.1.tar.gz (8.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page