phial
=====
|Documentation Status| |Github Actions| |Coverage Status| |PyPi|
A lightweight framework for building slack bots
Phial is a slack bot framework, modelled loosely on
`flask <https://github.com/pallets/flask/>`__.
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):
'''A command with an 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:
- Decorator based 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 © 2019 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/
.. |Github Actions| image:: https://github.com/sedders123/phial/workflows/CI/badge.svg
:target: https://github.com/sedders123/phial/actions
.. |Coverage Status| image:: https://codecov.io/gh/sedders123/phial/branch/develop/graph/badge.svg
:target: https://codecov.io/gh/sedders123/phial/
.. |PyPi| image:: https://badge.fury.io/py/phial-slack.svg
:target: https://badge.fury.io/py/phial-slack
Raw data
{
"_id": null,
"home_page": null,
"name": "phial-slack",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "James Seden Smith <sedders123@gmail.com>",
"keywords": "slack, bot, framework, phial, slackbot",
"author": null,
"author_email": "James Seden Smith <sedders123@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/1e/13/c1198b5a10cb38ca50f5b4c36820c9924e04636a27668497b25e8bf18a7c/phial_slack-0.12.0.tar.gz",
"platform": null,
"description": "phial\n=====\n\n|Documentation Status| |Github Actions| |Coverage Status| |PyPi|\n\n A lightweight framework for building slack bots\n\nPhial is a slack bot framework, modelled loosely on\n`flask <https://github.com/pallets/flask/>`__.\n\n\nTable of Contents\n-----------------\n\n- `Usage <#usage>`__\n- `Install <#install>`__\n- `Contribute <#contribute>`__\n- `Licenses <#licenses>`__\n\nUsage\n-----\n\nPython:\n~~~~~~~\n\n.. code:: python\n\n from phial import Phial, command, Response\n\n bot = Phial('---slack token here---')\n\n @bot.command('greet <name>')\n def greet(name):\n '''A command with an argument which replies to a message'''\n return \"Hello {0}\".format(name)\n\n bot.run()\n\nSlack:\n~~~~~~\n\nBy default the bot requires a prefix of ``!`` before its commands. This\ncan be changed in the config.\n\n::\n\n youruser:\n > !greet jim\n bot:\n > Hello Jim\n\nFeatures:\n\n- Decorator based command definition\n- Send messages to slack\n- Reply to messages in a thread\n- Reply to messages with a reaction\n- Upload Files\n\nExamples of commands utilising these features can be found in the\n`examples <examples/>`__ folder\n\nInstall\n-------\n\n::\n\n $ pip install phial-slack\n\nContribute\n----------\n\nIf a feature is missing, or you can improve the code please submit a PR\nor raise an Issue\n\nLicenses\n--------\n\nphial - MIT \u00a9 2019 James Seden Smith\n\nErlenmeyer Flask by Iconic from the Noun Project - `CC BY\n3.0 <https://creativecommons.org/licenses/by/3.0/>`__ (used in\n`examples/phial.png <examples/phial.png>`__)\n\n.. |Documentation Status| image:: https://readthedocs.org/projects/phial/badge/?version=develop\n :target: http://phial.readthedocs.io/en/develop/\n.. |Github Actions| image:: https://github.com/sedders123/phial/workflows/CI/badge.svg\n :target: https://github.com/sedders123/phial/actions\n.. |Coverage Status| image:: https://codecov.io/gh/sedders123/phial/branch/develop/graph/badge.svg\n :target: https://codecov.io/gh/sedders123/phial/\n.. |PyPi| image:: https://badge.fury.io/py/phial-slack.svg\n :target: https://badge.fury.io/py/phial-slack\n",
"bugtrack_url": null,
"license": null,
"summary": "A Slack bot framework",
"version": "0.12.0",
"project_urls": {
"Documentation": "https://phial.dev/",
"Homepage": "https://github.com/sedders123/phial/",
"Issues": "https://github.com/sedders123/phial/issues",
"Source": "https://github.com/sedders123/phial/"
},
"split_keywords": [
"slack",
" bot",
" framework",
" phial",
" slackbot"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8afa18a1cd65cf849550f70bb379ea6e1582ef62ca75098c3f849c60d422fa0c",
"md5": "3fa64647a55a2e20ee7081b66e7380c8",
"sha256": "ccd3e44a177ac1e7b4774af6bc9f007718ccad60f9f3dbcd12a03df7afe96180"
},
"downloads": -1,
"filename": "phial_slack-0.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3fa64647a55a2e20ee7081b66e7380c8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 14540,
"upload_time": "2025-02-08T00:57:58",
"upload_time_iso_8601": "2025-02-08T00:57:58.080777Z",
"url": "https://files.pythonhosted.org/packages/8a/fa/18a1cd65cf849550f70bb379ea6e1582ef62ca75098c3f849c60d422fa0c/phial_slack-0.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1e13c1198b5a10cb38ca50f5b4c36820c9924e04636a27668497b25e8bf18a7c",
"md5": "eb824ea46ffc7bd554f770c381884d1e",
"sha256": "39e7bb346dd5802e433abf7572f1f226ae1c395fbc86087b944766ae32b126b7"
},
"downloads": -1,
"filename": "phial_slack-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "eb824ea46ffc7bd554f770c381884d1e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 14556,
"upload_time": "2025-02-08T00:58:00",
"upload_time_iso_8601": "2025-02-08T00:58:00.343172Z",
"url": "https://files.pythonhosted.org/packages/1e/13/c1198b5a10cb38ca50f5b4c36820c9924e04636a27668497b25e8bf18a7c/phial_slack-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-08 00:58:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sedders123",
"github_project": "phial",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "phial-slack"
}
JSON
