donald


Namedonald JSON
Version 0.32.3 PyPI version JSON
download
home_page
SummaryTask manager for asyncio
upload_time2023-03-22 13:45:56
maintainer
docs_urlNone
author
requires_python>=3.8
licenseMIT License
keywords asyncio tasks queue
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Donald 0.32.3
#############

.. _description:

Donald -- A fast and simple tasks manager for Asyncio.


Donald supports synchronous and asynchronous paradigms. The package is running
coroutines and functions in multi loops. Donald could run periodic tasks and
listen AMQP queues.

.. _badges:

.. image:: https://github.com/klen/donald/workflows/tests/badge.svg
    :target: https://github.com/klen/donald/actions
    :alt: Tests Status

.. image:: https://img.shields.io/pypi/v/donald
    :target: https://pypi.org/project/donald/
    :alt: PYPI Version

.. image:: https://img.shields.io/pypi/pyversions/donald
    :target: https://pypi.org/project/donald/
    :alt: Python Versions

.. _contents:

.. contents::

.. _requirements:

Requirements
=============

- python 3.8+

.. _installation:

Installation
=============

**Donald** should be installed using pip: ::

    pip install donald

With redis support: ::

    pip install donald[redis]

.. _usage:

Quick Start
===========

Init the tasks manager:

.. code:: python

    # Init Donald
    manager = Donald(

        # Params (default values)
        # -----------------------

        # Setup logging
        log_level=logging.INFO,
        log_config=None,

        # Choose a backend (memory|redis|amqp)
        # memory - is only recommended for testing/local development
        backend='memory',

        # Backend connection params
        # redis: {'url': 'redis://localhost:6379/0', 'channel': 'donald'}
        # amqp: {'url': 'amqp://guest:guest@localhost:5672/', 'queue': 'donald', 'exchange': 'donald'}
        backend_params={},

        # Tasks worker params
        worker_params={
          # Max tasks in work
          'max_tasks': 0,

          # Tasks default params (delay, timeout)
          'task_defaults': {},

          # A awaitable function to run on worker start
          'on_start': None

          # A awaitable function to run on worker stop
          'on_stop': None

          # A awaitable function to run on worker error
          'on_error': None

        },
    )

    # Wrap a function to task
    @manager.task
    async def myfunc(*args, **kwargs):
        # Do some job here

    # Start the manager somewhere (on app start for example)
    await manager.start()

    # you may run a worker in the same process
    # not recommended for production
    worker = manager.create_worker()
    worker.start()

    # ...

    # Submit the task to workers
    myfunc.submit(*args, **kwargs)

    # ...

    # Stop the manager when you need
    await worker.stop()
    await manager.stop()


Schedule tasks
===============

.. code:: python

  @tasks.schedule('*/5 * * * *')  # Supports cron expressions, number of seconds, timedelta
  @tasks.task
  async def myfunc(*args, **kwargs):
      """Run every 5 minutes"""
      # Do some job here


  # you may run a scheduler in the same process
  # not recommended for production
  manager.scheduler.start()

  # ...

  # Stop the scheduler before stop the tasks manager
  manager.scheduler.stop()


Run in production
=================

Create a tasks manager somewhere in your app `tasks.py`:

.. code:: python

  manager = Donald(backend='amqp')

  # Setup your tasks and schedules.
  # See the Quick Start section for details.

Run a worker in a separate process:

.. code:: bash

   $ donald -M tasks.manager worker

Run a scheduler (if you need) in a separate process:

.. code:: bash

   $ donald -M tasks.manager scheduler

.. _bugtracker:

Bug tracker
===========

If you have any suggestions, bug reports or
annoyances please report them to the issue tracker
at https://github.com/klen/donald/issues

.. _contributing:

Contributing
============

Development of starter happens at github: https://github.com/klen/donald

.. _license:

License
========

Licensed under a `MIT license`_.

.. _links:

.. _MIT license: http://opensource.org/licenses/MIT
.. _klen: https://klen.github.io/

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "donald",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "asyncio,tasks,queue",
    "author": "",
    "author_email": "Kirill Klenov <horneds@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/d2/e6/44aef40d40ed1b8a7a4a04c562a242a600e005fe84541c0e43f1349dd332/donald-0.32.3.tar.gz",
    "platform": null,
    "description": "Donald 0.32.3\n#############\n\n.. _description:\n\nDonald -- A fast and simple tasks manager for Asyncio.\n\n\nDonald supports synchronous and asynchronous paradigms. The package is running\ncoroutines and functions in multi loops. Donald could run periodic tasks and\nlisten AMQP queues.\n\n.. _badges:\n\n.. image:: https://github.com/klen/donald/workflows/tests/badge.svg\n    :target: https://github.com/klen/donald/actions\n    :alt: Tests Status\n\n.. image:: https://img.shields.io/pypi/v/donald\n    :target: https://pypi.org/project/donald/\n    :alt: PYPI Version\n\n.. image:: https://img.shields.io/pypi/pyversions/donald\n    :target: https://pypi.org/project/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**Donald** should be installed using pip: ::\n\n    pip install donald\n\nWith redis support: ::\n\n    pip install donald[redis]\n\n.. _usage:\n\nQuick Start\n===========\n\nInit the tasks manager:\n\n.. code:: python\n\n    # Init Donald\n    manager = Donald(\n\n        # Params (default values)\n        # -----------------------\n\n        # Setup logging\n        log_level=logging.INFO,\n        log_config=None,\n\n        # Choose a backend (memory|redis|amqp)\n        # memory - is only recommended for testing/local development\n        backend='memory',\n\n        # Backend connection params\n        # redis: {'url': 'redis://localhost:6379/0', 'channel': 'donald'}\n        # amqp: {'url': 'amqp://guest:guest@localhost:5672/', 'queue': 'donald', 'exchange': 'donald'}\n        backend_params={},\n\n        # Tasks worker params\n        worker_params={\n          # Max tasks in work\n          'max_tasks': 0,\n\n          # Tasks default params (delay, timeout)\n          'task_defaults': {},\n\n          # A awaitable function to run on worker start\n          'on_start': None\n\n          # A awaitable function to run on worker stop\n          'on_stop': None\n\n          # A awaitable function to run on worker error\n          'on_error': None\n\n        },\n    )\n\n    # Wrap a function to task\n    @manager.task\n    async def myfunc(*args, **kwargs):\n        # Do some job here\n\n    # Start the manager somewhere (on app start for example)\n    await manager.start()\n\n    # you may run a worker in the same process\n    # not recommended for production\n    worker = manager.create_worker()\n    worker.start()\n\n    # ...\n\n    # Submit the task to workers\n    myfunc.submit(*args, **kwargs)\n\n    # ...\n\n    # Stop the manager when you need\n    await worker.stop()\n    await manager.stop()\n\n\nSchedule tasks\n===============\n\n.. code:: python\n\n  @tasks.schedule('*/5 * * * *')  # Supports cron expressions, number of seconds, timedelta\n  @tasks.task\n  async def myfunc(*args, **kwargs):\n      \"\"\"Run every 5 minutes\"\"\"\n      # Do some job here\n\n\n  # you may run a scheduler in the same process\n  # not recommended for production\n  manager.scheduler.start()\n\n  # ...\n\n  # Stop the scheduler before stop the tasks manager\n  manager.scheduler.stop()\n\n\nRun in production\n=================\n\nCreate a tasks manager somewhere in your app `tasks.py`:\n\n.. code:: python\n\n  manager = Donald(backend='amqp')\n\n  # Setup your tasks and schedules.\n  # See the Quick Start section for details.\n\nRun a worker in a separate process:\n\n.. code:: bash\n\n   $ donald -M tasks.manager worker\n\nRun a scheduler (if you need) in a separate process:\n\n.. code:: bash\n\n   $ donald -M tasks.manager scheduler\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/donald/issues\n\n.. _contributing:\n\nContributing\n============\n\nDevelopment of starter happens at github: https://github.com/klen/donald\n\n.. _license:\n\nLicense\n========\n\nLicensed under a `MIT license`_.\n\n.. _links:\n\n.. _MIT license: http://opensource.org/licenses/MIT\n.. _klen: https://klen.github.io/\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Task manager for asyncio",
    "version": "0.32.3",
    "split_keywords": [
        "asyncio",
        "tasks",
        "queue"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eb0810904c713655263b0e989e0b5b751457141afd4e57e4b2e5da49604f267d",
                "md5": "dcf40b49453199c446130cc005c0a256",
                "sha256": "50a713b032b770fedad6b97accc79761a3226e6199d043a1378ddf7ce03b5476"
            },
            "downloads": -1,
            "filename": "donald-0.32.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "dcf40b49453199c446130cc005c0a256",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 12510,
            "upload_time": "2023-03-22T13:45:54",
            "upload_time_iso_8601": "2023-03-22T13:45:54.340541Z",
            "url": "https://files.pythonhosted.org/packages/eb/08/10904c713655263b0e989e0b5b751457141afd4e57e4b2e5da49604f267d/donald-0.32.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d2e644aef40d40ed1b8a7a4a04c562a242a600e005fe84541c0e43f1349dd332",
                "md5": "830d80772f7456fec67fc555507d0510",
                "sha256": "500b87e98453099771cbca6e02c253f93631c7e2f71ba5777d35422bf6d19ae4"
            },
            "downloads": -1,
            "filename": "donald-0.32.3.tar.gz",
            "has_sig": false,
            "md5_digest": "830d80772f7456fec67fc555507d0510",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 13052,
            "upload_time": "2023-03-22T13:45:56",
            "upload_time_iso_8601": "2023-03-22T13:45:56.164481Z",
            "url": "https://files.pythonhosted.org/packages/d2/e6/44aef40d40ed1b8a7a4a04c562a242a600e005fe84541c0e43f1349dd332/donald-0.32.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-22 13:45:56",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "donald"
}
        
Elapsed time: 0.05471s