Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,22 @@ curl -X POST 'http://127.0.0.1:8000/api/v1/tasks/task?message=hello'

More examples (superuser creation, tiers, rate limits, admin usage) in the [docs](https://benavlabs.github.io/FastAPI-boilerplate/getting-started/first-run/).

## Background jobs & ARQ

This boilerplate ships with [ARQ](https://github.com/samuelcolvin/arq) as the default async background worker built on top of Redis. It is proven and works well for many use cases, but is currently in maintenance mode rather than active feature development.

For most projects, ARQ is still a solid choice if:

- you are comfortable with Redis as the only dependency for background jobs, and
- you prefer a lightweight, fully-async worker that integrates nicely with FastAPI.

If your team expects to invest heavily in background processing (workflows, retries, scheduling, monitoring, etc.), you may want to:

- keep ARQ for now and plan a migration path later, or
- swap ARQ out for another worker (e.g. RQ, Celery, Dramatiq, or a hosted solution) behind the same queue abstractions.

See the [background tasks guide](https://benavlabs.github.io/FastAPI-boilerplate/user-guide/background-tasks/) for more details on how ARQ is wired into this project and how to adapt it to your own needs.

## Contributing

Read [contributing](CONTRIBUTING.md).
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ dependencies = [
"alembic>=1.13.1",
"asyncpg>=0.29.0",
"SQLAlchemy-Utils>=0.41.1",
"python-jose>=3.3.0",
"PyJWT>=2.8.0",
"SQLAlchemy>=2.0.25",
"python-multipart>=0.0.9",
"greenlet>=2.0.2",
Expand All @@ -27,7 +27,7 @@ dependencies = [
"redis>=5.0.1",
"arq>=0.25.0",
"bcrypt>=4.1.1",
"psycopg2-binary>=2.9.9",
"psycopg2>=2.9.9",
"fastcrud>=0.19.2",
"crudadmin>=0.4.2",
"gunicorn>=23.0.0",
Expand Down
57 changes: 13 additions & 44 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.