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.9
.. _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": "https://github.com/klen/muffin-donald",
"name": "muffin-donald",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "muffin, asyncio, trio, curio",
"author": "Kirill Klenov",
"author_email": "horneds@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d8/bb/46f131a259a9b793ec38fce1680de7787a899a444d6483c7869e2f91227d/muffin_donald-0.12.0.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.9\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",
"summary": "It's a plugin for Muffin framework which provides support for external APIs",
"version": "0.12.0",
"project_urls": {
"Homepage": "https://github.com/klen/muffin-donald",
"Repository": "https://github.com/klen/muffin-donald"
},
"split_keywords": [
"muffin",
" asyncio",
" trio",
" curio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a9488396e178da5ab51a8107a5ee117e786e4253be9096f2d0df639ec05d22b6",
"md5": "ed6dab741cb75b832bc1783cf8c9ad88",
"sha256": "02364a9f4656b907130c39deb2b1c4faaff78196d1ec516395684c637fe371da"
},
"downloads": -1,
"filename": "muffin_donald-0.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ed6dab741cb75b832bc1783cf8c9ad88",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 4543,
"upload_time": "2024-11-01T09:53:39",
"upload_time_iso_8601": "2024-11-01T09:53:39.655686Z",
"url": "https://files.pythonhosted.org/packages/a9/48/8396e178da5ab51a8107a5ee117e786e4253be9096f2d0df639ec05d22b6/muffin_donald-0.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d8bb46f131a259a9b793ec38fce1680de7787a899a444d6483c7869e2f91227d",
"md5": "d10e1063d39c82818a9506fac6124808",
"sha256": "32c6366ec022ad514d1bcf30c2cb6bc3cebf3676c82ada7c37c2c0d71accbc1f"
},
"downloads": -1,
"filename": "muffin_donald-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "d10e1063d39c82818a9506fac6124808",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 4314,
"upload_time": "2024-11-01T09:53:41",
"upload_time_iso_8601": "2024-11-01T09:53:41.297307Z",
"url": "https://files.pythonhosted.org/packages/d8/bb/46f131a259a9b793ec38fce1680de7787a899a444d6483c7869e2f91227d/muffin_donald-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-01 09:53:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "klen",
"github_project": "muffin-donald",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "muffin-donald"
}
JSON
