Metadata-Version: 2.1
Name: patter
Version: 0.2.1
Summary: Pipe stdout directly to Mattermost channels or users.
Home-page: https://github.com/brodan/patter
Author: Christopher Hranj
Author-email: christopher.hranj@gmail.com
License: MIT
Keywords: patter mattermost
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
Requires-Dist: mattermostdriver (>=5.0.0)

# patter

> Pipe stdout directly to [Mattermost](https://mattermost.com/).

![patter demo](https://github.com/Brodan/patter/blob/master/demo.gif)

## Install

```
$ pip install patter
```

Then set the following environment variables based on your Mattermost server's config:
```
MATTERMOST_TEAM_NAME
MATTERMOST_URL
MATTERMOST_USERNAME
MATTERMOST_PASSWORD
MATTERMOST_PORT
```

## Usage

> Send a message to a user.
```
echo "testing" | patter -u some_user
```

> Send a message to a channel.
```
echo "testing" | patter -c town-square
```

> Send a file.
```
patter -c town-square -f some_file.txt
```

## Todo
- [ ] add unit tests via pytest
- [ ] allow message/files that are not UTF-8 to be sent
- [ ] add option of reading from a .patter file instead of using env vars.
- [ ] remove prints and add logging via verbose flag

## Contribute

PRs accepted.

## License

MIT © Christopher Hranj

Notice: This project was developed in part during my 10% time at [Truveris, Inc](https://www.truveris.com/).


