| Name | muffin-donald JSON |
| Version |
0.10.4
JSON |
| download |
| home_page | |
| Summary | It's a plugin for Muffin framework which provides support for external APIs |
| upload_time | 2023-03-22 13:58:59 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License |
| keywords |
muffin
asyncio
trio
curio
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Muffin-Donald
#############
.. _description:
**Muffin-Donald** -- Its a plugin for Muffin_ framework which provides support
for asyncronous tasks
.. _badges:
.. image:: https://github.com/klen/muffin-donald/workflows/tests/badge.svg
:target: https://github.com/klen/muffin-donald/actions
:alt: Tests Status
.. image:: https://img.shields.io/pypi/v/muffin-donald
:target: https://pypi.org/project/muffin-donald/
:alt: PYPI Version
.. image:: https://img.shields.io/pypi/pyversions/muffin-donald
:target: https://pypi.org/project/muffin-donald/
:alt: Python Versions
.. _contents:
.. contents::
.. _requirements:
Requirements
=============
- python >= 3.8
.. _installation:
Installation
=============
**Muffin-Donald** should be installed using pip: ::
pip install muffin-donald
.. _usage:
Usage
=====
Initialize and setup the plugin:
.. code-block:: python
import muffin
import muffin_donald
# Create Muffin Application
app = muffin.Application('example')
# Initialize the plugin
# As alternative: tasks = muffin_donald.Plugin(app, **options)
tasks = muffin_donald.Plugin()
donald.setup(app)
And etc
Options
-------
=========================== =========================== ===========================
Name Default value Desctiption
--------------------------- --------------------------- ---------------------------
**log_level** ``INFO`` Logger Level
**log_config** ``None`` Logger config
**backend** ``'memory'`` Backend name (memory, redis, amqp)
**backend_params** ``{}`` Backend params
**worker_params** ``{}`` Worker params
**worker_lifespan** ``False`` Fun the application lifespan events with worker
**start_worker** ``False`` Auto start a worker in the current process
**start_scheduler** ``False`` Auto start a scheduler in the current process
=========================== =========================== ===========================
You are able to provide the options when you are initiliazing the plugin:
.. code-block:: python
donald.setup(app, start_worker=True)
Or setup it inside ``Muffin.Application`` config using the ``TASKS_`` prefix:
.. code-block:: python
TASKS_START_WORKER = True
``Muffin.Application`` configuration options are case insensitive
.. _bugtracker:
Bug tracker
===========
If you have any suggestions, bug reports or
annoyances please report them to the issue tracker
at https://github.com/klen/muffin-donald/issues
.. _contributing:
Contributing
============
Development of Muffin-Donald happens at: https://github.com/klen/muffin-donald
Contributors
=============
* klen_ (Kirill Klenov)
.. _license:
License
========
Licensed under a `MIT license`_.
.. _links:
.. _klen: https://github.com/klen
.. _Muffin: https://github.com/klen/muffin
.. _MIT license: http://opensource.org/licenses/MIT
Raw data
{
"_id": null,
"home_page": "",
"name": "muffin-donald",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "muffin,asyncio,trio,curio",
"author": "",
"author_email": "Kirill Klenov <horneds@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/41/db/acf711188c9ef55f9e279e1a18a7123893a6b46dbd41c9bc5982a5a534db/muffin-donald-0.10.4.tar.gz",
"platform": null,
"description": "Muffin-Donald\n#############\n\n.. _description:\n\n**Muffin-Donald** -- Its a plugin for Muffin_ framework which provides support\nfor asyncronous tasks\n\n.. _badges:\n\n.. image:: https://github.com/klen/muffin-donald/workflows/tests/badge.svg\n :target: https://github.com/klen/muffin-donald/actions\n :alt: Tests Status\n\n.. image:: https://img.shields.io/pypi/v/muffin-donald\n :target: https://pypi.org/project/muffin-donald/\n :alt: PYPI Version\n\n.. image:: https://img.shields.io/pypi/pyversions/muffin-donald\n :target: https://pypi.org/project/muffin-donald/\n :alt: Python Versions\n\n.. _contents:\n\n.. contents::\n\n.. _requirements:\n\nRequirements\n=============\n\n- python >= 3.8\n\n.. _installation:\n\nInstallation\n=============\n\n**Muffin-Donald** should be installed using pip: ::\n\n pip install muffin-donald\n\n.. _usage:\n\nUsage\n=====\n\n\nInitialize and setup the plugin:\n\n.. code-block:: python\n\n import muffin\n import muffin_donald\n\n # Create Muffin Application\n app = muffin.Application('example')\n\n # Initialize the plugin\n # As alternative: tasks = muffin_donald.Plugin(app, **options)\n tasks = muffin_donald.Plugin()\n donald.setup(app)\n\n\nAnd etc\n\nOptions\n-------\n\n=========================== =========================== ===========================\nName Default value Desctiption\n--------------------------- --------------------------- ---------------------------\n**log_level** ``INFO`` Logger Level\n**log_config** ``None`` Logger config\n**backend** ``'memory'`` Backend name (memory, redis, amqp)\n**backend_params** ``{}`` Backend params\n**worker_params** ``{}`` Worker params\n**worker_lifespan** ``False`` Fun the application lifespan events with worker\n**start_worker** ``False`` Auto start a worker in the current process\n**start_scheduler** ``False`` Auto start a scheduler in the current process\n=========================== =========================== ===========================\n\n\nYou are able to provide the options when you are initiliazing the plugin:\n\n.. code-block:: python\n\n donald.setup(app, start_worker=True)\n\n\nOr setup it inside ``Muffin.Application`` config using the ``TASKS_`` prefix:\n\n.. code-block:: python\n\n TASKS_START_WORKER = True\n\n``Muffin.Application`` configuration options are case insensitive\n\n\n.. _bugtracker:\n\nBug tracker\n===========\n\nIf you have any suggestions, bug reports or\nannoyances please report them to the issue tracker\nat https://github.com/klen/muffin-donald/issues\n\n.. _contributing:\n\nContributing\n============\n\nDevelopment of Muffin-Donald happens at: https://github.com/klen/muffin-donald\n\n\nContributors\n=============\n\n* klen_ (Kirill Klenov)\n\n.. _license:\n\nLicense\n========\n\nLicensed under a `MIT license`_.\n\n.. _links:\n\n\n.. _klen: https://github.com/klen\n.. _Muffin: https://github.com/klen/muffin\n\n.. _MIT license: http://opensource.org/licenses/MIT\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "It's a plugin for Muffin framework which provides support for external APIs",
"version": "0.10.4",
"split_keywords": [
"muffin",
"asyncio",
"trio",
"curio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9ce143a2657f2be46f0cedfedf324c05b960d1313871e2bd7f18ec5377770fe8",
"md5": "c2bc800dde2d0fe9db0b3057d720d587",
"sha256": "61570ee9f62d0651ea9c4da4a9222ef03262c2189c6d494783515ac349161c3b"
},
"downloads": -1,
"filename": "muffin_donald-0.10.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c2bc800dde2d0fe9db0b3057d720d587",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4895,
"upload_time": "2023-03-22T13:58:57",
"upload_time_iso_8601": "2023-03-22T13:58:57.547768Z",
"url": "https://files.pythonhosted.org/packages/9c/e1/43a2657f2be46f0cedfedf324c05b960d1313871e2bd7f18ec5377770fe8/muffin_donald-0.10.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "41dbacf711188c9ef55f9e279e1a18a7123893a6b46dbd41c9bc5982a5a534db",
"md5": "9177e214b7d8e29c8e00c07ba411d123",
"sha256": "a76a809b48a7a3e7f278bc3d9d2c1e74c6fb94e29681913af31f78d98be4a70b"
},
"downloads": -1,
"filename": "muffin-donald-0.10.4.tar.gz",
"has_sig": false,
"md5_digest": "9177e214b7d8e29c8e00c07ba411d123",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4977,
"upload_time": "2023-03-22T13:58:59",
"upload_time_iso_8601": "2023-03-22T13:58:59.334984Z",
"url": "https://files.pythonhosted.org/packages/41/db/acf711188c9ef55f9e279e1a18a7123893a6b46dbd41c9bc5982a5a534db/muffin-donald-0.10.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-22 13:58:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "muffin-donald"
}
