Python Jupyter Notebook
Clone or download
FabioRosado and jacobtomlinson Fix no-else-return lint issues (#578)
* Disable no-else-return error

* Fix no-else-return lint issues
Latest commit 8bd6406 Jul 17, 2018
Permalink
Failed to load latest commit information.
docs Add support for ipython notebooks as skills (#573) Jul 16, 2018
opsdroid Fix no-else-return lint issues (#578) Jul 17, 2018
scripts Replace except pass with contextlib.suppress (#543) Jun 2, 2018
tests Add support for ipython notebooks as skills (#573) Jul 16, 2018
.coveragerc Coverage only for opsdroid and flake8 ignore modules Jul 30, 2016
.gitignore Merge Slack and Websocket connectors to the core project (#530) Jun 15, 2018
.travis.yml Fix the current mkdocs.yml and add tests for future use (#399) Jan 18, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#188) Jun 17, 2017
Dockerfile Use gettext for translations (#433) Feb 9, 2018
LICENSE Change to the Apache 2.0 license (#320) Oct 31, 2017
MANIFEST.in Use gettext for translations (#433) Feb 9, 2018
README.md Use appdir library to move config/logs (#529) Apr 25, 2018
appveyor.yml Add windows support (#382) Jan 17, 2018
mkdocs.yml Add vim tutorial to mkdocs (#556) Jun 15, 2018
pylintrc Merge Slack and Websocket connectors to the core project (#530) Jun 15, 2018
requirements.txt Add support for ipython notebooks as skills (#573) Jul 16, 2018
requirements_dev.txt Update mkdocs from 0.17.4 to 0.17.5 (#570) Jul 9, 2018
requirements_readthedocs.txt Add empty requirements file as workaround to read the docs bug (#557) Jun 16, 2018
requirements_test.txt Update asynctest from 0.12.1 to 0.12.2 (#562) Jul 9, 2018
setup.cfg Use gettext for translations (#433) Feb 9, 2018
setup.py Use appdir library to move config/logs (#529) Apr 25, 2018
tox.ini Merge Slack and Websocket connectors to the core project (#530) Jun 15, 2018

README.md

opsdroidTweet

Current version of pypi Build Status Build status codecov Updates Dependency Status Docker Build Docker Image Docker Layers Documentation Status Gitter Badge Backers on Open Collective Sponsors on Open Collective Open Source Helpers

An open source chat bot framework written in python. It is designed to be extendable, scalable and simple.

This application is designed to take messages from chat services and execute python functions (skills) based on their contents. Those functions can be anything you like, from simple conversational responses to running complex tasks. The true power of this project is to act as a glue library to bring the multitude of natural language APIs, chat services and third party APIs together.

ChatOps

"ChatOps is an operational paradigm where work that is already happening in the background today is brought into a common chatroom. By doing this, you are unifying the communication about what work should get done with actual history of the work being done." - StackStorm

In the new frontier of DevOps it is becoming more and more popular to interact with your automation tools via an instant messenger. opsdroid is a framework to make creating and extending your ChatOps workflows powerful but simple.

Why use opsdroid?

  • It's open source
  • Simple to modify and extend
  • Add your own skills in under 10 lines of python
  • Easy to install
  • Designed with Docker in mind for simple deployment
  • Configurable with a single YAML file
  • Can connect to multiple chat services simultaneously
  • No coding necessary if using the official modules

Quick start

pip3 install opsdroid
opsdroid

Installation

Check out the Getting Started video series on YouTube. The video series demonstrates how to install and configure opsdroid and opsdroid desktop on Ubuntu 16.04. It also demonstrates how to create your own skill in opsdroid

Docker

# Pull the container image
docker pull opsdroid/opsdroid:latest

# Run the container
docker run --rm -it -v /path/to/configuration.yaml:/etc/opsdroid/configuration.yaml:ro opsdroid/opsdroid:latest

Ubuntu 16.04 LTS

# Update apt-get
sudo apt-get update

# Install pip for python3 and locales
sudo apt-get install python3-pip language-pack-en git

# Enure pip is up-to-date
pip3 install --upgrade pip

# Install opsdroid
sudo pip3 install opsdroid

# Run opsdroid
opsdroid

Usage

When running the opsdroid command with no arguments the bot framework will start using the configuration in ~/.opsdroid/configuration.yaml. Beginners should check out the introduction tutorial for information on how to configure opsdroid.

For information on arguments that you can pass to opsdroid run opsdroid --help.

$ opsdroid --help
Usage: opsdroid [OPTIONS]

  Opsdroid is a chat bot framework written in python.

  It is designed to be extendable, scalable and simple. See
  https://opsdroid.github.io/ for more information.

Options:
  --gen-config          Print an example config and exit.
  -v, --version         Print the version and exit.
  -e, --edit-config     Edit configuration.yaml
  -l, --view-log        Open opsdroid logs 
  --help                Show this message and exit.

Contributing

Stickers for contributors!

Contributing to the opsdroid ecosystem is strongly encouraged and every little bit counts! 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 the project founder 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.

Do you need help? Do you want to chat? Join our Gitter channel


* databases are optional, however bot memory will not persist between different connectors or system reboots without one

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! πŸ™ [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]