Add shields to repo (#37)

* add shields to repo and iterate version

* fix line break
pull/38/head v1.4.5
Mal Hancock 2018-10-10 10:49:33 -07:00 committed by GitHub
parent f65248f797
commit 6df2cb9d79
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 40 additions and 25 deletions

View File

@ -1,4 +1,6 @@
# pinhook # pinhook
[![Supported Python versions](https://img.shields.io/pypi/pyversions/pinhook.svg)](https://pypi.org/project/pinhook) [![Package License](https://img.shields.io/pypi/l/pinhook.svg)](https://github.com/archangelic/pinhook/blob/master/LICENSE) [![PyPI package format](https://img.shields.io/pypi/format/pinhook.svg)](https://pypi.org/project/pinhook) [![Package development status](https://img.shields.io/pypi/status/pinhook.svg)](https://pypi.org/project/pinhook) [![With love from tilde.town](https://img.shields.io/badge/with%20love%20from-tilde%20town-e0b0ff.svg)](https://tilde.town)
the pluggable python framework for IRC bots and Twitch bots the pluggable python framework for IRC bots and Twitch bots
## Tutorial ## Tutorial

View File

@ -1,6 +1,9 @@
pinhook pinhook
======= =======
|Supported Python versions| |Package License| |PyPI package format|
|Package development status| |With love from tilde.town|
the pluggable python framework for IRC bots and Twitch bots the pluggable python framework for IRC bots and Twitch bots
Tutorial Tutorial
@ -11,7 +14,7 @@ Installation
:: ::
$ pip install pinhook $ pip install pinhook
Creating an IRC Bot Creating an IRC Bot
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
@ -20,14 +23,14 @@ To create the bot, just create a python file with the following:
.. code:: python .. code:: python
from pinhook.bot import Bot from pinhook.bot import Bot
bot = Bot( bot = Bot(
channels=['#foo', '#bar'], channels=['#foo', '#bar'],
nickname='ph-bot', nickname='ph-bot',
server='irc.freenode.net' server='irc.freenode.net'
) )
bot.start() bot.start()
This will start a basic bot and look for plugins in the 'plugins' This will start a basic bot and look for plugins in the 'plugins'
directory to add functionality. directory to add functionality.
@ -53,14 +56,14 @@ Pinhook has a baked in way to connect directly to a twitch channel
.. code:: python .. code:: python
from pinhook.bot import TwitchBot from pinhook.bot import TwitchBot
bot = TwitchBot( bot = TwitchBot(
nickname='ph-bot', nickname='ph-bot',
channel='#channel', channel='#channel',
token='super-secret-oauth-token' token='super-secret-oauth-token'
) )
bot.start() bot.start()
This function has far less options, as the server, port, and ssl are This function has far less options, as the server, port, and ssl are
already handled by twitch. already handled by twitch.
@ -84,12 +87,12 @@ The function will need to be structured as such:
.. code:: python .. code:: python
import pinhook.plugin import pinhook.plugin
@pinhook.plugin.register('!test') @pinhook.plugin.register('!test')
def test_plugin(msg): def test_plugin(msg):
message = '{}: this is a test!'.format(msg.nick) message = '{}: this is a test!'.format(msg.nick)
return pinhook.plugin.message(message) return pinhook.plugin.message(message)
The function will need to accept a single argument in order to accept a The function will need to accept a single argument in order to accept a
``Message`` object from the bot. ``Message`` object from the bot.
@ -121,3 +124,14 @@ repository.
For a live and maintained bot running the current version of pinhook see For a live and maintained bot running the current version of pinhook see
`pinhook-tilde <https://github.com/archangelic/pinhook-tilde>`__. `pinhook-tilde <https://github.com/archangelic/pinhook-tilde>`__.
.. |Supported Python versions| image:: https://img.shields.io/pypi/pyversions/pinhook.svg
:target: https://pypi.org/project/pinhook
.. |Package License| image:: https://img.shields.io/pypi/l/pinhook.svg
:target: https://github.com/archangelic/pinhook/blob/master/LICENSE
.. |PyPI package format| image:: https://img.shields.io/pypi/format/pinhook.svg
:target: https://pypi.org/project/pinhook
.. |Package development status| image:: https://img.shields.io/pypi/status/pinhook.svg
:target: https://pypi.org/project/pinhook
.. |With love from tilde.town| image:: https://img.shields.io/badge/with%20love%20from-tilde%20town-e0b0ff.svg
:target: https://tilde.town

View File

@ -73,7 +73,7 @@ class UploadCommand(Command):
# Where the magic happens: # Where the magic happens:
setup( setup(
name=NAME, name=NAME,
version='1.4.4', version='1.4.5',
description=DESCRIPTION, description=DESCRIPTION,
long_description=long_description, long_description=long_description,
author=AUTHOR, author=AUTHOR,
@ -87,14 +87,13 @@ setup(
# Trove classifiers # Trove classifiers
# Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers # Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers
'License :: OSI Approved :: MIT License', 'License :: OSI Approved :: MIT License',
'Development Status :: 5 - Production/Stable',
'Programming Language :: Python', 'Programming Language :: Python',
'Programming Language :: Python :: 2.6', 'Programming Language :: Python :: 3 :: only',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
], ],
# $ setup.py publish support. # $ setup.py publish support.
cmdclass={ cmdclass={