Merge pull request #19 from sedders123/pypi

Setup for PyPi

README.rst

@@ -0,0 +1,92 @@
+phial
+=====
+
+|Documentation Status| |CircleCI| |Coverage Status|
+
+    A simple framework for building slack bots
+
+Phial is a slack bot framework, modelled loosely on
+`flask <https://github.com/pallets/flask/>`__.
+
+NOTE: This package is still in early development, things are likely to
+change
+
+Table of Contents
+-----------------
+
+-  `Usage <#usage>`__
+-  `Install <#install>`__
+-  `Contribute <#contribute>`__
+-  `Licenses <#licenses>`__
+
+Usage
+-----
+
+Python:
+~~~~~~~
+
+.. code:: python
+
+    from phial import Phial, command, Response
+
+    bot = Phial('---slack token here---')
+
+    @bot.command('greet <name>')
+    def greet(name):
+        '''Simple command with argument which replies to a message'''
+        return "Hello {0}".format(name)
+
+    bot.run()
+
+Slack:
+~~~~~~
+
+By default the bot requires a prefix of ``!`` before its commands. This
+can be changed in the config.
+
+::
+
+    youruser:
+    > !greet jim
+    bot:
+    > Hello Jim
+
+Features:
+
+-  Simple command definition
+-  Send messages to slack
+-  Reply to messages in a thread
+-  Reply to messages with a reaction
+-  Upload Files
+
+Examples of commands utilising these features can be found in the
+`examples <examples/>`__ folder
+
+Install
+-------
+
+::
+
+      $ pip install phial-slack
+
+Contribute
+----------
+
+If a feature is missing, or you can improve the code please submit a PR
+or raise an Issue
+
+Licenses
+--------
+
+phial - MIT © 2017 James Seden Smith
+
+Erlenmeyer Flask by Iconic from the Noun Project - `CC BY
+3.0 <https://creativecommons.org/licenses/by/3.0/>`__ (used in
+`examples/phial.png <examples/phial.png>`__)
+
+.. |Documentation Status| image:: https://readthedocs.org/projects/phial/badge/?version=develop
+   :target: http://phial.readthedocs.io/en/develop/
+.. |CircleCI| image:: https://circleci.com/gh/sedders123/phial.svg?style=svg
+   :target: https://circleci.com/gh/sedders123/phial
+.. |Coverage Status| image:: https://coveralls.io/repos/github/sedders123/phial/badge.svg?branch=develop
+   :target: https://coveralls.io/github/sedders123/phial?branch=develop

setup.cfg

@@ -1,3 +1,2 @@
 [metadata]
 license_file = LICENSE
-description-file = README.md

setup.py

@@ -1,30 +1,30 @@
 from setuptools import setup
 
 setup(
-    name='phial',
+    name='phial-slack',
     version='0.1.0',
     url='https://github.com/sedders123/phial/',
     license='MIT',
     author='James Seden Smith',
     author_email='[email protected]',
-    description='A slack bot framework',
+    description='A Slack bot framework',
+    long_description=open('README.rst').read(),
     packages=['phial'],
     include_package_data=True,
     zip_safe=False,
     platforms='any',
+    python_requires='>=3.6',
+    keywords=['Slack', 'bot', 'Slackbot'],
     install_requires=[
         'slackclient==1.0.6',
         'Werkzeug==0.12.2',
     ],
     classifiers=[
-        'Development Status :: 2 - Pre-Alpha',
+        'Development Status :: 3 - Alpha',
         'License :: OSI Approved :: MIT License',
         'Intended Audience :: Developers',
         'Operating System :: OS Independent',
         'Programming Language :: Python',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
         'Topic :: Software Development :: Libraries :: Python Modules'
     ]