Skip to main content

A Python Mattermost Driver

Project description

# Python Mattermost Driver (APIv4)

## Info

Currently WIP / Unstable

## Installation
NOT WORKING YET!
`pip install mattermostdriver`

## Usage

```python
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.

Files for mattermostdriver, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size mattermostdriver-0.2.0.tar.gz (8.5 kB) File type Source Python version None Upload date Hashes View hashes

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