Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.15 KB

Readme.md

File metadata and controls

41 lines (26 loc) · 1.15 KB

FastAPI Task Management

This is a simple app to demonstrate a simple task management API.

Tasks are run using FastAPI Background Tasks as async functions. The "task" is a sleep for 10 seconds.

The following endpoints are provided:

  • /docs - the SwaggerUI for this App. Also usable to try out the service.

  • /start: starts a new task, returns something like:

    {"task_id":"4d15b40a748341358a6024437ef7de4c"}

    The task is started in a Background Task and listens also on a redis queue specific for this task to await potential cancellation.

  • /status/{task_id}: returns the status of the given task which is either unknown, started, finished or cancelled.

  • /cancel/{task_id}: cancel a task when it is started, no-op if status is otherwise. This sends a message via Redis to a task specific queue.

Development

To set up everything:

pip install -r requirements.txt

To start redis:

docker run --name my-redis -p 6379:6379 --rm redis

To start the app:

uvicorn app.main:app --reload

Which now listens on 127.0.0.1:8000