Metadata-Version: 2.0
Name: bottery
Version: 0.0.1a14
Summary: A bot framework with batteries included
Home-page: https://github.com/rougeth/bottery
Author: Marco Rougeth
Author-email: marco@rougeth.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Topic :: Software Development :: User Interfaces
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
Requires-Dist: aiohttp
Requires-Dist: attrs
Requires-Dist: click
Requires-Dist: halo
Requires-Dist: jinja2
Requires-Dist: requests
Provides-Extra: dev
Requires-Dist: coverage; extra == 'dev'
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: isort; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-aiohttp; extra == 'dev'
Requires-Dist: pytest-asyncio; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest-mock; extra == 'dev'
Requires-Dist: sphinx; extra == 'dev'
Requires-Dist: testfixtures; extra == 'dev'

# 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).


