# Flask-Celery-Tools
This is a fork of [Flask-Celery-Helper](https://github.com/Robpol86/Flask-Celery-Helper)
Even though the [Flask documentation](http://flask.pocoo.org/docs/patterns/celery/) says Celery extensions are
unnecessary now, I found that I still need an extension to properly use Celery in large Flask applications. Specifically
I need an init_app() method to initialize Celery after I instantiate it.
This extension also comes with a ``single_instance`` method.
* Python PyPy, 3.6, 3.7 and 3.8 supported on Linux and OS X.
* Python 3.6, 3.7 and 3.8 supported on Windows (both 32 and 64 bit versions of Python).
[](https://ci.appveyor.com/project/Salamek/Flask-Celery-Tools) [](https://travis-ci.com/Salamek/Flask-Celery-Tools ) [](https://codecov.io/gh/Salamek/Flask-Celery-Tools) [](https://pypi.python.org/pypi/Flask-Celery-Tools)
## Attribution
Single instance decorator inspired by [Ryan Roemer](http://loose-bits.com/2010/10/distributed-task-locking-in-celery.html).
## Supported Libraries
* [Flask](http://flask.pocoo.org/) 0.12 to 1.1.2
* [Redis](http://redis.io/) 3.2.6 to 3.5.3
* [Celery](http://www.celeryproject.org/) 3.1.11 to 4.4.7
## Quickstart
Install:
```bash
pip install Flask-Celery-Helper
```
## Examples
### Basic Example
```python
# example.py
from flask import Flask
from flask_celery import Celery
app = Flask('example')
app.config['CELERY_BROKER_URL'] = 'redis://localhost'
app.config['CELERY_RESULT_BACKEND'] = 'redis://localhost'
app.config['CELERY_TASK_LOCK_BACKEND'] = 'redis://localhost'
celery = Celery(app)
@celery.task()
def add_together(a, b):
return a + b
if __name__ == '__main__':
result = add_together.delay(23, 42)
print(result.get())
```
Run these two commands in separate terminals:
```bash
celery -A example.celery worker
python example.py
```
### Factory Example
```python
# extensions.py
from flask_celery import Celery
celery = Celery()
```
```python
# application.py
from flask import Flask
from extensions import celery
def create_app():
app = Flask(__name__)
app.config['CELERY_IMPORTS'] = ('tasks.add_together', )
app.config['CELERY_BROKER_URL'] = 'redis://localhost'
app.config['CELERY_RESULT_BACKEND'] = 'redis://localhost'
app.config['CELERY_TASK_LOCK_BACKEND'] = 'redis://localhost'
celery.init_app(app)
return app
```
```python
# tasks.py
from extensions import celery
@celery.task()
def add_together(a, b):
return a + b
```
```python
# manage.py
from application import create_app
app = create_app()
app.run()
```
### Single Instance Example
```python
# example.py
import time
from flask import Flask
from flask_celery import Celery, single_instance
from flask_redis import Redis
app = Flask('example')
app.config['REDIS_URL'] = 'redis://localhost'
app.config['CELERY_BROKER_URL'] = 'redis://localhost'
app.config['CELERY_RESULT_BACKEND'] = 'redis://localhost'
app.config['CELERY_TASK_LOCK_BACKEND'] = 'redis://localhost'
celery = Celery(app)
Redis(app)
@celery.task(bind=True)
@single_instance
def sleep_one_second(a, b):
time.sleep(1)
return a + b
if __name__ == '__main__':
task1 = sleep_one_second.delay(23, 42)
time.sleep(0.1)
task2 = sleep_one_second.delay(20, 40)
results1 = task1.get(propagate=False)
results2 = task2.get(propagate=False)
print(results1) # 65
if isinstance(results2, Exception) and str(results2) == 'Failed to acquire lock.':
print('Another instance is already running.')
else:
print(results2) # Should not happen.
```
### Locking backends
Flask-Celery-Tools supports multiple locking backends you can use:
#### Filesystem
Filesystem locking backend is using file locks on filesystem where worker is running, WARNING this backend is not usable for distributed tasks!!!
#### Redis
Redis backend is using redis for storing task locks, this backend is good for distributed tasks.
#### Database (MariaDB, PostgreSQL, etc)
Database backend is using database supported by SqlAlchemy to store task locks, this backend is good for distributed tasks. Except sqlite database that have same limitations as filesystem backend.
## Changelog
This project adheres to [Semantic Versioning](http://semver.org/).
1.4.1 - 2020-11-10
------------------
* Require flask>=1.0.2
1.4.0 - 2020-11-04
------------------
* Migrate to new (4.0>) celery config names, just UPPERCASE and prefixed with CELERY_ this is BC break see https://docs.celeryproject.org/en/stable/userguide/configuration.html for new config key names
1.3.1 - 2020-11-03
------------------
* Celery 5 support added
1.2.9 - 2020-11-03
------------------
* Bump celery to version 4.4.7
1.2.7 - 2020-09-12
------------------
* Set username for twine in CI release
1.2.6 - 2020-09-10
------------------
* Fixed archlinux build
1.2.5 - 2020-09-10
------------------
* Update dependencies
* Fixed unittests
1.2.4 - 2018-11-03
------------------
* Append celery_self if task is bound
1.1.0 - 2014-12-28
------------------
Added
* Windows support.
* `single_instance` supported on SQLite/MySQL/PostgreSQL in addition to Redis.
Changed
* `CELERY_RESULT_BACKEND` no longer mandatory.
* Breaking changes: `flask.ext.celery.CELERY_LOCK` moved to `flask.ext.celery._LockManagerRedis.CELERY_LOCK`.
1.0.0 - 2014-11-01
------------------
Added
* Support for non-Redis backends.
0.2.2 - 2014-08-11
------------------
Added
* Python 2.6 and 3.x support.
0.2.1 - 2014-06-18
------------------
Fixed
* `single_instance` arguments with functools.
0.2.0 - 2014-06-18
------------------
Added
* `include_args` argument to `single_instance`.
0.1.0 - 2014-06-01
------------------
* Initial release.
Raw data
{
"_id": null,
"home_page": "https://github.com/Salamek/Flask-Celery-Tools",
"name": "Flask-Celery-Tools",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "flask celery redis",
"author": "@Salamek",
"author_email": "adam.schubert@sg1-game.net",
"download_url": "https://files.pythonhosted.org/packages/51/b6/3e17d4d66732b0c71c44b101df75d13d5df0751404422e28acac271aadab/Flask-Celery-Tools-1.4.3.tar.gz",
"platform": null,
"description": "# Flask-Celery-Tools \n \nThis is a fork of [Flask-Celery-Helper](https://github.com/Robpol86/Flask-Celery-Helper) \n \nEven though the [Flask documentation](http://flask.pocoo.org/docs/patterns/celery/) says Celery extensions are \nunnecessary now, I found that I still need an extension to properly use Celery in large Flask applications. Specifically \nI need an init_app() method to initialize Celery after I instantiate it. \n \nThis extension also comes with a ``single_instance`` method. \n \n* Python PyPy, 3.6, 3.7 and 3.8 supported on Linux and OS X.\n* Python 3.6, 3.7 and 3.8 supported on Windows (both 32 and 64 bit versions of Python).\n \n[](https://ci.appveyor.com/project/Salamek/Flask-Celery-Tools) [](https://travis-ci.com/Salamek/Flask-Celery-Tools ) [](https://codecov.io/gh/Salamek/Flask-Celery-Tools) [](https://pypi.python.org/pypi/Flask-Celery-Tools)\n \n## Attribution \n\nSingle instance decorator inspired by [Ryan Roemer](http://loose-bits.com/2010/10/distributed-task-locking-in-celery.html). \n \n## Supported Libraries \n \n* [Flask](http://flask.pocoo.org/) 0.12 to 1.1.2\n* [Redis](http://redis.io/) 3.2.6 to 3.5.3\n* [Celery](http://www.celeryproject.org/) 3.1.11 to 4.4.7 \n \n## Quickstart \n\nInstall: \n \n```bash \npip install Flask-Celery-Helper \n ```\n## Examples \n \n### Basic Example\n \n```python \n# example.py \nfrom flask import Flask \nfrom flask_celery import Celery \n\napp = Flask('example') \napp.config['CELERY_BROKER_URL'] = 'redis://localhost' \napp.config['CELERY_RESULT_BACKEND'] = 'redis://localhost' \napp.config['CELERY_TASK_LOCK_BACKEND'] = 'redis://localhost' \ncelery = Celery(app) \n\n@celery.task() \ndef add_together(a, b): \n return a + b \n\nif __name__ == '__main__': \n result = add_together.delay(23, 42) \n print(result.get()) \n```\nRun these two commands in separate terminals:\n\n```bash\ncelery -A example.celery worker\npython example.py\n```\n### Factory Example\n\n```python\n# extensions.py\nfrom flask_celery import Celery\n\ncelery = Celery()\n```\n\n```python\n# application.py\nfrom flask import Flask\nfrom extensions import celery\n\ndef create_app():\n app = Flask(__name__)\n app.config['CELERY_IMPORTS'] = ('tasks.add_together', )\n app.config['CELERY_BROKER_URL'] = 'redis://localhost'\n app.config['CELERY_RESULT_BACKEND'] = 'redis://localhost'\n app.config['CELERY_TASK_LOCK_BACKEND'] = 'redis://localhost'\n celery.init_app(app)\n return app\n```\n\n```python\n# tasks.py\nfrom extensions import celery\n\n@celery.task()\ndef add_together(a, b):\n return a + b\n```\n\n```python\n# manage.py\nfrom application import create_app\n\napp = create_app()\napp.run()\n```\n\n### Single Instance Example\n\n```python\n# example.py\nimport time\nfrom flask import Flask\nfrom flask_celery import Celery, single_instance\nfrom flask_redis import Redis\n\napp = Flask('example')\napp.config['REDIS_URL'] = 'redis://localhost'\napp.config['CELERY_BROKER_URL'] = 'redis://localhost'\napp.config['CELERY_RESULT_BACKEND'] = 'redis://localhost'\napp.config['CELERY_TASK_LOCK_BACKEND'] = 'redis://localhost'\ncelery = Celery(app)\nRedis(app)\n\n@celery.task(bind=True)\n@single_instance\ndef sleep_one_second(a, b):\n time.sleep(1)\n return a + b\n\nif __name__ == '__main__':\n task1 = sleep_one_second.delay(23, 42)\n time.sleep(0.1)\n task2 = sleep_one_second.delay(20, 40)\n results1 = task1.get(propagate=False)\n results2 = task2.get(propagate=False)\n print(results1) # 65\n if isinstance(results2, Exception) and str(results2) == 'Failed to acquire lock.':\n print('Another instance is already running.')\n else:\n print(results2) # Should not happen.\n```\n\n### Locking backends\n\nFlask-Celery-Tools supports multiple locking backends you can use:\n\n#### Filesystem\n\nFilesystem locking backend is using file locks on filesystem where worker is running, WARNING this backend is not usable for distributed tasks!!!\n\n#### Redis\n\nRedis backend is using redis for storing task locks, this backend is good for distributed tasks.\n\n\n#### Database (MariaDB, PostgreSQL, etc)\n\nDatabase backend is using database supported by SqlAlchemy to store task locks, this backend is good for distributed tasks. Except sqlite database that have same limitations as filesystem backend.\n\n\n## Changelog\n\nThis project adheres to [Semantic Versioning](http://semver.org/).\n\n1.4.1 - 2020-11-10\n------------------\n * Require flask>=1.0.2\n\n1.4.0 - 2020-11-04\n------------------\n * Migrate to new (4.0>) celery config names, just UPPERCASE and prefixed with CELERY_ this is BC break see https://docs.celeryproject.org/en/stable/userguide/configuration.html for new config key names\n\n1.3.1 - 2020-11-03\n------------------\n * Celery 5 support added\n\n1.2.9 - 2020-11-03\n------------------\n * Bump celery to version 4.4.7\n\n1.2.7 - 2020-09-12\n------------------\n * Set username for twine in CI release\n\n1.2.6 - 2020-09-10\n------------------\n * Fixed archlinux build\n\n1.2.5 - 2020-09-10\n------------------\n * Update dependencies\n * Fixed unittests\n\n1.2.4 - 2018-11-03\n------------------\n * Append celery_self if task is bound\n\n1.1.0 - 2014-12-28\n------------------\n\nAdded\n * Windows support.\n * `single_instance` supported on SQLite/MySQL/PostgreSQL in addition to Redis.\n\nChanged\n * `CELERY_RESULT_BACKEND` no longer mandatory.\n * Breaking changes: `flask.ext.celery.CELERY_LOCK` moved to `flask.ext.celery._LockManagerRedis.CELERY_LOCK`.\n\n1.0.0 - 2014-11-01\n------------------\n\nAdded\n * Support for non-Redis backends.\n\n0.2.2 - 2014-08-11\n------------------\n\nAdded\n * Python 2.6 and 3.x support.\n\n0.2.1 - 2014-06-18\n------------------\n\nFixed\n * `single_instance` arguments with functools.\n\n0.2.0 - 2014-06-18\n------------------\n\nAdded\n * `include_args` argument to `single_instance`.\n\n0.1.0 - 2014-06-01\n------------------\n\n* Initial release.",
"bugtrack_url": null,
"license": "MIT",
"summary": "Celery support for Flask without breaking PyCharm inspections.",
"version": "1.4.3",
"project_urls": {
"Homepage": "https://github.com/Salamek/Flask-Celery-Tools"
},
"split_keywords": [
"flask",
"celery",
"redis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "51b63e17d4d66732b0c71c44b101df75d13d5df0751404422e28acac271aadab",
"md5": "8b2a3ccce0f723bd04b8e01ecca8d467",
"sha256": "8444cb5b718483de11f26e7ae2f803ebac4737d7e9421eefbb3c53020c57a07c"
},
"downloads": -1,
"filename": "Flask-Celery-Tools-1.4.3.tar.gz",
"has_sig": false,
"md5_digest": "8b2a3ccce0f723bd04b8e01ecca8d467",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11273,
"upload_time": "2024-06-04T17:55:55",
"upload_time_iso_8601": "2024-06-04T17:55:55.033985Z",
"url": "https://files.pythonhosted.org/packages/51/b6/3e17d4d66732b0c71c44b101df75d13d5df0751404422e28acac271aadab/Flask-Celery-Tools-1.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-04 17:55:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Salamek",
"github_project": "Flask-Celery-Tools",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"appveyor": true,
"tox": true,
"lcname": "flask-celery-tools"
}
JSON
