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.8+

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.32.1.tar.gz (12.9 kB view details)

Uploaded Source

Built Distribution

donald-0.32.1-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: donald-0.32.1.tar.gz
  • Upload date:
  • Size: 12.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for donald-0.32.1.tar.gz
Algorithm Hash digest
SHA256 f36a751de6beba46f8c4ecf25d01c620a455a5efdc838c9e801e0f06ff778f64
MD5 60ce7aa71ade1aa636a66ed5d4db6843
BLAKE2b-256 41bc372e0ed61177df0fd05d1a8531240054b90944c6b9e457f1b285800b8431

See more details on using hashes here.

File details

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

File metadata

  • Download URL: donald-0.32.1-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for donald-0.32.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ca432c2e88f11964b0d72445d324256302b6890d5ed88b45600459ff5b4ffeb3
MD5 dc3fcfc428633a5533c68bd50dfeb545
BLAKE2b-256 9b25bb028b9a50afcca4631f999591b68a67a20112c8611331c53f61269d2b0f

See more details on using hashes here.

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