muffin-donald


Namemuffin-donald JSON
Version 0.2.0 PyPI version JSON
download
home_pagehttps://github.com/klen/muffin-donald
SummaryIt's a plugin for Muffin framework which provides support for external APIs
upload_time2021-06-14 16:31:46
maintainer
docs_urlNone
authorKirill Klenov
requires_python>=3.7
licenseMIT
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.7

.. _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
--------------------------- --------------------------- ---------------------------
**autostart**               ``True``                    Auto start tasks workers
**fake_mode**               ``False``                   Run tasks immediately (testing)
**num_workers**             ``<CPU_COUNT> - 1``         Number of workers
**max_tasks_per_worker**    ``100``                     Maximum concurent tasks per worker
**filelock**                ``None``                    File lock path
**loglevel**                ``INFO``                    Logger Level
**queue_exchange**          ``tasks``                   Tasks queue exchange
**queue_name**              ``tasks``                   Tasks queue name
**queue_params**            ``{}``                      Queue params
=========================== =========================== =========================== 


You are able to provide the options when you are initiliazing the plugin:

.. code-block:: python

    donald.setup(app, num_workers=2)


Or setup it inside ``Muffin.Application`` config using the ``DONALD_`` prefix:

.. code-block:: python

   DONALD_ROOT_URL = 'https://api.github.com'

``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": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "muffin,asyncio,trio,curio",
    "author": "Kirill Klenov",
    "author_email": "horneds@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/60/ca/842a89f6cb34fb22ba4dd42a49f823b2a4d5669e433c6dce3a933c6612d2/muffin-donald-0.2.0.tar.gz",
    "platform": "",
    "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.7\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**autostart**               ``True``                    Auto start tasks workers\n**fake_mode**               ``False``                   Run tasks immediately (testing)\n**num_workers**             ``<CPU_COUNT> - 1``         Number of workers\n**max_tasks_per_worker**    ``100``                     Maximum concurent tasks per worker\n**filelock**                ``None``                    File lock path\n**loglevel**                ``INFO``                    Logger Level\n**queue_exchange**          ``tasks``                   Tasks queue exchange\n**queue_name**              ``tasks``                   Tasks queue name\n**queue_params**            ``{}``                      Queue params\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, num_workers=2)\n\n\nOr setup it inside ``Muffin.Application`` config using the ``DONALD_`` prefix:\n\n.. code-block:: python\n\n   DONALD_ROOT_URL = 'https://api.github.com'\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\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "It's a plugin for Muffin framework which provides support for external APIs",
    "version": "0.2.0",
    "split_keywords": [
        "muffin",
        "asyncio",
        "trio",
        "curio"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "beab237e0ccfbf2df1458001bc5a36e5",
                "sha256": "e2d8bc574f2577ee9cc6d3adca3cd3cf46d17f41c651c7ba419662be1cfe5350"
            },
            "downloads": -1,
            "filename": "muffin_donald-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "beab237e0ccfbf2df1458001bc5a36e5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 4715,
            "upload_time": "2021-06-14T16:31:44",
            "upload_time_iso_8601": "2021-06-14T16:31:44.845586Z",
            "url": "https://files.pythonhosted.org/packages/7f/52/8290dc3ee643e2bae28d3537bef986d7aa4518337da86dcce734f636bbbd/muffin_donald-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "802537cb4f2311dd8041c37661efac56",
                "sha256": "3ca8c7714fc0ab6b2409bdb06655e3922561ba7a3c6a0be117ff76e7dbd63895"
            },
            "downloads": -1,
            "filename": "muffin-donald-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "802537cb4f2311dd8041c37661efac56",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 4944,
            "upload_time": "2021-06-14T16:31:46",
            "upload_time_iso_8601": "2021-06-14T16:31:46.318786Z",
            "url": "https://files.pythonhosted.org/packages/60/ca/842a89f6cb34fb22ba4dd42a49f823b2a4d5669e433c6dce3a933c6612d2/muffin-donald-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-06-14 16:31:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "klen",
    "error": "Could not fetch GitHub repository",
    "lcname": "muffin-donald"
}
        
Elapsed time: 0.33466s