muffin-donald 0.1.0

It's a plugin for Muffin framework which provides support for external APIs

Muffin-Donald – Its a plugin for Muffin framework which provides support for asyncronous tasks

Contents

• Requirements

• Installation

• Usage

  • Options

• Bug tracker

• Contributing

• Contributors

• License

Requirements

• python >= 3.7

Installation

Muffin-Donald should be installed using pip:

pip install muffin-donald

Usage

Initialize and setup the plugin:

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:

donald.setup(app, num_workers=2)

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

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

Muffin.Application configuration options are case insensitive

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

Development of Muffin-Donald happens at: https://github.com/klen/muffin-donald

Contributors

• klen (Kirill Klenov)

License

Licensed under a MIT license.