Donald is here
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.
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 workerRun a scheduler (if you need) in a separate process:
$ donald -M tasks.manager schedulerBug 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 BSD license.
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
Built Distribution
File details
Details for the file donald-0.30.0.tar.gz.
File metadata
- Download URL: donald-0.30.0.tar.gz
- Upload date:
- Size: 11.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | de49a640e8e5ba34f73bb2e80bc89096221e20c8d86e1ad46fb677d440affe51 |
|
| MD5 | c1bc212360732752d3163b143e2aa9c5 |
|
| BLAKE2b-256 | 9ef92a4a06e2d62370e0c90edcf6b7f0f982eb1b05a3eef5e330f1b136ed9713 |
File details
Details for the file donald-0.30.0-py3-none-any.whl.
File metadata
- Download URL: donald-0.30.0-py3-none-any.whl
- Upload date:
- Size: 12.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 15bfdb4ab02599bdd0abcca3c1bc7a25732e5f6c4fe2ec92b15c3bb65c4996c0 |
|
| MD5 | caee85644e4363411f1d13b3329dfe8f |
|
| BLAKE2b-256 | 23854ee8593d39df205d1c83b21f2d2afd72db12f97aefcf856ea9ba627793ae |
