Skip to main content

A bot framework with batteries included

Project description

# bottery
:battery: A framework for building bots

[![Build Status](https://travis-ci.org/rougeth/bottery.svg?branch=master)](https://travis-ci.org/rougeth/bottery)
[![Build status](https://ci.appveyor.com/api/projects/status/we3h64nj98vvxcre/branch/master?svg=true)](https://ci.appveyor.com/project/rougeth/bottery/branch/master)
[![PyPI](https://img.shields.io/pypi/v/bottery.svg)](https://pypi.python.org/pypi/bottery)
[![Versions](https://img.shields.io/pypi/pyversions/bottery.svg)](https://pypi.python.org/pypi/bottery)

```python
# quick example of a ping pong bot
from bottery import Bottery


bot = Bottery()

@bot.patterns.message('ping')
def pong(message):
return 'pong'
```

The complete example can be seen [here](https://github.com/leportella/bottery-examples).

* [Usage](#usage)
* [Documentation](http://docs.bottery.io)
* [Installing](#installing)
* [Creating a project](#creating-a-project)
* [Running](#running)
* [Development](#development)

## Usage

### Installing
```bash
$ pip install bottery
```

### Creating a project
```bash
$ bottery startproject librarybot
```

### Running
```bash
$ bottery run
```

## Development

Please see [our contribution guide](CONTRIBUTING.rst).


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

bottery-0.0.1a15-py3-none-any.whl (19.1 kB view hashes)

Uploaded Python 3

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