Skip to main content

Task manager for asyncio

Project 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.

Tests Status PYPI Version Python Versions

Requirements

  • python 3.9+

Installation

Donald should be installed using pip:

pip install donald

With redis support:

pip install donald[redis]

Quick Start

Init the tasks manager:

# 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

@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:

manager = Donald(backend='amqp')

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

Run a worker in a separate process:

$ donald -M tasks.manager worker

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

$ donald -M tasks.manager scheduler

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

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

License

Licensed under a MIT license.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

donald-0.33.0.tar.gz (13.3 kB view details)

Uploaded Source

Built Distribution

donald-0.33.0-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file donald-0.33.0.tar.gz.

File metadata

  • Download URL: donald-0.33.0.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for donald-0.33.0.tar.gz
Algorithm Hash digest
SHA256 07f29a47e7c2030c7d3793718e9124f90dbf41b0bf2fa7a54dbf871744a976ad
MD5 b9eec010cb833162f1680b0e49abf0b6
BLAKE2b-256 4d289b195c4d471381ca7eb4a197efc37db779263eaaa236e7b2d7af5cc806b4

See more details on using hashes here.

Provenance

File details

Details for the file donald-0.33.0-py3-none-any.whl.

File metadata

  • Download URL: donald-0.33.0-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for donald-0.33.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4fee54adcc458ad93456d26d7e8834b0c7ac0b54a168e0e4f7b19d1f507a1a06
MD5 ddcc5eab83865cef9fc21ebf9312ccd8
BLAKE2b-256 360baf4933ec14431fa4c2551620ddfc414307f705e9684f354a246d90d9a853

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page