GitHub - rande/python-shirka: A Python Bot

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 92 Commits
shirka		shirka
.gitignore		.gitignore
.travis.yml		.travis.yml
AUTHORS		AUTHORS
LICENSE		LICENSE
MANIFEST.in		MANIFEST.in
README.txt		README.txt
config.yml.sample		config.yml.sample
makefile		makefile
pip_requirements.txt		pip_requirements.txt
setup.py		setup.py
tests.py		tests.py

Repository files navigation

======
Shirka
======

This a bot based on twisted, mostly a python learning project

Consumers
=========

* flowdock: read message from flow dock stream API
* stdin: read message from the cli (testing only)

Responders
==========

* face
* whois
* math
* wat
* xkcd
* ascii
* 9gag
* jira

Installation
============

    virtualenv shirka 
    cd shirka
    source bin/activate
    
    pip install shirka
    python -m shirka --destination bot
    
Usage
=====

    cd bot
    python start.py shirka:start

Running Tests
=============

.. code-block:: python

    python tests.py # run all tests
    python -m unittest responders.xkcd # run one test