An open source chat-ops bot.
Project description
[](https://travis-ci.org/opsdroid/opsdroid) [](https://coveralls.io/github/opsdroid/opsdroid?branch=release) [](https://pyup.io/repos/github/opsdroid/opsdroid/) [](https://dependencyci.com/github/opsdroid/opsdroid)
[](https://hub.docker.com/r/opsdroid/opsdroid/) [](https://microbadger.com/#/images/opsdroid/opsdroid) [](http://opsdroid.readthedocs.io/en/latest/?badge=latest)
An open source python chat-ops bot framework.
## Quick start
```
pip3 install opsdroid
opsdroid
```
## Configuration
Configuration is done in a yaml file called `configuration.yaml`. This will be created automatically for you in `~/.opsdroid`. See the [full reference](http://opsdroid.readthedocs.io/en/latest/configuration-reference/).
Example config:
```yaml
## _ _ _
## ___ _ __ ___ __| |_ __ ___ (_) __| |
## / _ \| '_ \/ __|/ _` | '__/ _ \| |/ _` |
## | (_) | |_) \__ \ (_| | | | (_) | | (_| |
## \___/| .__/|___/\__,_|_| \___/|_|\__,_|
## |_|
## __ _
## ___ ___ _ __ / _(_) __ _
## / __/ _ \| '_ \| |_| |/ _` |
## | (_| (_) | | | | _| | (_| |
## \___\___/|_| |_|_| |_|\__, |
## |___/
##
## A default config file to use with opsdroid
## Set the logging level
# logging:
# level: info
# path: opsdroid.log
# console: true
## Set the location for opsdroid to install modules
# module-path: "."
## Parsers
# parsers:
# - name: regex
# enabled: true
#
# - name: crontab
# enabled: true
#
# - name: apiai
# access-token: "youraccesstoken"
# min-score: 0.6
## Connector modules
connectors:
- name: shell
## Database modules (optional)
# databases:
## Skill modules
skills:
## Hello world (https://github.com/opsdroid/skill-hello)
- name: hello
## Last seen (https://github.com/opsdroid/skill-seen)
- name: seen
## Dance (https://github.com/opsdroid/skill-dance)
- name: dance
## Loud noises (https://github.com/opsdroid/skill-loudnoises)
- name: loudnoises
```
## Contributing
Contributing to the opsdroid ecosystem is strongly encouraged. You can do this by creating modules to be used by opsdroid or by contributing to the project itself.
All contributors to the project, including [jacobtomlinson](https://github.com/jacobtomlinson), contribute using the following process:
* Fork the main project to your own account
* Work on your changes on a feature branch
* Create a pull request back to the main project
* Tests and test coverage will be checked automatically
* A project maintainer will review and merge the pull request
For more information see the [contribution documentation](http://opsdroid.readthedocs.io/en/latest/contributing/).
[](https://travis-ci.org/opsdroid/opsdroid) [](https://coveralls.io/github/opsdroid/opsdroid?branch=release) [](https://pyup.io/repos/github/opsdroid/opsdroid/) [](https://dependencyci.com/github/opsdroid/opsdroid)
[](https://hub.docker.com/r/opsdroid/opsdroid/) [](https://microbadger.com/#/images/opsdroid/opsdroid) [](http://opsdroid.readthedocs.io/en/latest/?badge=latest)
An open source python chat-ops bot framework.
## Quick start
```
pip3 install opsdroid
opsdroid
```
## Configuration
Configuration is done in a yaml file called `configuration.yaml`. This will be created automatically for you in `~/.opsdroid`. See the [full reference](http://opsdroid.readthedocs.io/en/latest/configuration-reference/).
Example config:
```yaml
## _ _ _
## ___ _ __ ___ __| |_ __ ___ (_) __| |
## / _ \| '_ \/ __|/ _` | '__/ _ \| |/ _` |
## | (_) | |_) \__ \ (_| | | | (_) | | (_| |
## \___/| .__/|___/\__,_|_| \___/|_|\__,_|
## |_|
## __ _
## ___ ___ _ __ / _(_) __ _
## / __/ _ \| '_ \| |_| |/ _` |
## | (_| (_) | | | | _| | (_| |
## \___\___/|_| |_|_| |_|\__, |
## |___/
##
## A default config file to use with opsdroid
## Set the logging level
# logging:
# level: info
# path: opsdroid.log
# console: true
## Set the location for opsdroid to install modules
# module-path: "."
## Parsers
# parsers:
# - name: regex
# enabled: true
#
# - name: crontab
# enabled: true
#
# - name: apiai
# access-token: "youraccesstoken"
# min-score: 0.6
## Connector modules
connectors:
- name: shell
## Database modules (optional)
# databases:
## Skill modules
skills:
## Hello world (https://github.com/opsdroid/skill-hello)
- name: hello
## Last seen (https://github.com/opsdroid/skill-seen)
- name: seen
## Dance (https://github.com/opsdroid/skill-dance)
- name: dance
## Loud noises (https://github.com/opsdroid/skill-loudnoises)
- name: loudnoises
```
## Contributing
Contributing to the opsdroid ecosystem is strongly encouraged. You can do this by creating modules to be used by opsdroid or by contributing to the project itself.
All contributors to the project, including [jacobtomlinson](https://github.com/jacobtomlinson), contribute using the following process:
* Fork the main project to your own account
* Work on your changes on a feature branch
* Create a pull request back to the main project
* Tests and test coverage will be checked automatically
* A project maintainer will review and merge the pull request
For more information see the [contribution documentation](http://opsdroid.readthedocs.io/en/latest/contributing/).
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
opsdroid-0.8.1.tar.gz
(25.0 kB
view details)
File details
Details for the file opsdroid-0.8.1.tar.gz.
File metadata
- Download URL: opsdroid-0.8.1.tar.gz
- Upload date:
- Size: 25.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4145c06ed0155dccd0eab3d1c68748ffbe396cf09f6149723adf5d776f4d13be |
|
| MD5 | aeae3c14f9b2d41968d522b4e98f6307 |
|
| BLAKE2b-256 | 72b0876c9d7578f953d87519c60731cef67451aab39f80388df128e1af5d2c16 |
