KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #cli #open-source #ai #claude-code #codex #developer-tools #react #windows #deepseek-harness #ai-agent

python-flask-celery-example

★ 41 Open GitHub ↗

Flask Rest API with the use of Celery

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Python3 Flask Rest API with Celery example

[![Build Status](https://travis-ci.org/matthieugouel/python-flask-celery-example.svg?branch=master)](https://travis-ci.org/matthieugouel/python-flask-celery-example)
[![Coverage Status](https://img.shields.io/coveralls/github/matthieugouel/python-flask-celery-example.svg)](https://coveralls.io/github/matthieugouel/python-flask-celery-example?branch=master)
[![license](https://img.shields.io/github/license/matthieugouel/python-flask-celery-example.svg)](https://github.com/matthieugouel/python-flask-celery-example/blob/master/LICENSE)

This project is an example of using Flask-restful and celery to perform asynchronous tasks.

## Installation

Note : The installation into a virtualenv is heavily recommended.

If you want to install the package :

```
pip install .
```

For development purposes, you can install the package in editable mode with the dev requirements.

```
pip install -e . -r requirements-dev.txt
```

## Usage

To start the application, you can use the file run.py :

```
python run.py
```

Moreover, to be able to play with celery, you have to first start Redis, then start a celery worker like this :

```
celery -A run.celery worker --loglevel=info
```

Note : It's cleaner to use docker-compose to start the whole application (see the section below).

## Usage with Docker Compose

In order to start the whole system easily, we can use docker-compose :

```
docker-compose up
```

It will start three docker containers :
- Redis
- Flask API
- Celery Worker

Then, you can access to the API in localhost :

```
curl -X GET -H "Content-Type: application/json" localhost:5000/api/bye/test
```

## Syntax

You can check the syntax using flake8 (you must have flake8 package installed first) :

```
flake8 api
```

You can also use tox (you must have tox package installed first) :

```
tox -e lint
```

## Test coverage

To execute the test coverage, you must install the package with the dev requirements (see installation section).

You can run the coverage with the following command :

```
coverage run --source api -m py.test
```

You can also use tox (you must have tox package installed first) :

```
tox -e test
```

python-flask-celery-example

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README