Metadata-Version: 2.0
Name: discord-travisbot
Version: 0.0.1.dev20170516
Summary: Travis bot for Discord.
Home-page: UNKNOWN
Author: Yoan Blanc
Author-email: yoan@dosimple.ch
License: https://opensource.org/licenses/BSD-3-Clause
Keywords: discord asyncio bot
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Education
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: aiohttp (>=2.0.0)
Provides-Extra: fast
Requires-Dist: aiodns; extra == 'fast'
Requires-Dist: cchardet; extra == 'fast'
Provides-Extra: qa
Requires-Dist: flake8; extra == 'qa'
Requires-Dist: isort; extra == 'qa'
Requires-Dist: pycodestyle; extra == 'qa'
Requires-Dist: pydocstyle; extra == 'qa'
Requires-Dist: rstcheck; extra == 'qa'

============
 Travis Bot
============

.. image:: https://travis-ci.org/greut/travisbot.svg?branch=master
   :target: https://travis-ci.org/greut/travisbot

.. image:: https://img.shields.io/pypi/dd/discord-travisbot.svg
   :target: https://pypi.python.org/pypi/discord-travisbot

.. image:: https://img.shields.io/github/stars/greut/travisbot.svg
   :target: https://github.com/greut/travisbot/stargazers

A bot for Discord. (Work in progress)

Development
===========

To setup and run the basic steps of the bot.

Requirements
------------

- `Python 3.6 <https://www.python.org/>`_
- `ngrok <https://ngrok.com/>`_

Installation
------------

.. code-block:: console

    $ python -m venv .
    $ . bin/activate
    (travisbot)$ pip install -e .[fast]

Running
-------

The secret token is read from the environment variables.

.. code-block:: console

    (travisbot)$ export TOKEN=...
    (travisbot)$ python -m travisbot

In a separate process, run ``ngrok``.

.. code-block:: console

    $ ngrok http 8888

Then, configure the notifications of your project to point to the given URL:
`Configuring webhook notifications <https://docs.travis-ci.com/user/notifications/#Configuring-webhook-notifications>`_


Release
=======

Update the version number and clean up the ``dist`` directory before-hand.

.. code-block:: console

    (travisbot)$ python setup.py register -r https://pypi.python.org/pypi
    (travisbot)$ pip install wheel twine
    (travisbot)$ python setup.py bdist_wheel
    (travisbot)$ twine upload dist/*

Bibliography
============

- `A Discord bot with asyncio <https://tutorials.botsfloor.com/a-discord-bot-with-asyncio-359a2c99e256>`_
- `Discord API Reference <https://discordapp.com/developers/docs/reference>`_
- `discord.py <https://github.com/Rapptz/discord.py>`_


