https://github.com/celery/pytest-celery
Official pytest plugin for Celery.
https://github.com/celery/pytest-celery
celery docker pytest python
Last synced: 9 months ago
JSON representation
Official pytest plugin for Celery.
- Host: GitHub
- URL: https://github.com/celery/pytest-celery
- Owner: celery
- License: other
- Created: 2020-08-05T11:28:52.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-31T16:43:37.000Z (10 months ago)
- Last Synced: 2025-04-11T13:59:44.845Z (9 months ago)
- Topics: celery, docker, pytest, python
- Language: Python
- Homepage: https://pytest-celery.readthedocs.io/
- Size: 1.65 MB
- Stars: 67
- Watchers: 11
- Forks: 16
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- Changelog: Changelog.rst
- Contributing: CONTRIBUTING.rst
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
|build-status| |coverage| |license| |semgrep| |pyversion| |pyimp| |ocbackerbadge| |ocsponsorbadge| |poetry|
:Version: 1.2.0
:Web: https://pytest-celery.readthedocs.io/en/latest/
:Download: https://pypi.org/project/pytest-celery/
:Source: https://github.com/celery/pytest-celery/
===================================
Official pytest plugin for Celery
===================================
Welcome to `pytest-celery`_, the official pytest plugin for Celery.
.. _`pytest-celery`: https://pypi.org/project/pytest-celery/
The pytest-celery plugin introduces significant enhancements with the introduction of
version >= 1.0.0, shifting towards a Docker-based approach for smoke and production-like testing.
While the ``celery.contrib.pytest`` API continues to support detailed integration
and unit testing, the new Docker-based methodology is tailored for testing in
environments that closely mirror production settings.
Adopting version >= 1.0.0 enriches your testing suite with these new capabilities
without affecting your existing tests, allowing for a smooth upgrade path.
The documentation here will navigate you through utilizing the Docker-based approach.
For information on the ``celery.contrib.pytest`` API for integration and unit testing,
please refer to the `official documentation`_.
.. _`official documentation`: https://docs.celeryproject.org/en/latest/userguide/testing.html
The pytest-celery plugin is Open Source and licensed under the `BSD License`_.
.. _`BSD License`: https://www.opensource.org/license/BSD-3-Clause
Donations
=========
This project relies on your generous donations.
If you are using pytest-celery to test a commercial product, please consider becoming
our `backer`_ or our `sponsor`_ to ensure pytest-celery's future.
.. _`backer`: https://opencollective.com/celery
.. _`sponsor`: https://opencollective.com/celery
Getting Started
===============
- If you're new to pytest-celery you can get started by following the `Getting Started`_ tutorial.
- You can also check out the `FAQ`_.
.. _`Getting Started`: https://docs.celeryq.dev/projects/pytest-celery/en/latest/getting-started/index.html#getting-started
.. _`FAQ`: https://docs.celeryq.dev/projects/pytest-celery/en/latest/faq.html#faq
Contents
========
- `Copyright `_
- `Getting Started`_
- `Introduction to pytest-celery `_
- `First Steps with pytest-celery `_
- `Next Steps `_
- `Vendors `_
- `Help `_
- `User Guide `_
- `Advanced Installation Guide `_
- `Test Setup Matrix `_
- `How to prepare the Celery application `_
- `How to inject your own utility functions `_
- `How to add tasks `_
- `Built-in Tasks `_
- `How to connect signal handlers `_
- `Standalone Celery Bug Report `_
- `Examples `_
- `Useful Resources `_
- `Plugin Development Guide `_
- `Local Development Environment `_
- `Tox Environments `_
- `Sphinx Documentation `_
- `How to release a new version `_
- `API Documentation `_
- `Contributing `_
- `FAQ`_
- `Change history `_
- `Glossary `_
.. |build-status| image:: https://github.com/celery/pytest-celery/actions/workflows/python-package.yml/badge.svg
:alt: Build status
:target: https://github.com/celery/pytest-celery/actions/workflows/python-package.yml
.. |coverage| image:: https://codecov.io/github/celery/pytest-celery/coverage.svg?branch=main
:target: https://codecov.io/github/celery/pytest-celery?branch=main
.. |license| image:: https://img.shields.io/pypi/l/pytest-celery.svg
:alt: BSD License
:target: https://opensource.org/licenses/BSD-3-Clause
.. |semgrep| image:: https://img.shields.io/badge/semgrep-security-green.svg
:alt: Semgrep security
:target: https://go.semgrep.dev/home
.. |pyversion| image:: https://img.shields.io/pypi/pyversions/pytest-celery.svg
:alt: Supported Python versions.
:target: https://pypi.org/project/pytest-celery/
.. |pyimp| image:: https://img.shields.io/pypi/implementation/pytest-celery.svg
:alt: Supported Python implementations.
:target: https://pypi.org/project/pytest-celery/
.. |ocbackerbadge| image:: https://opencollective.com/celery/backers/badge.svg
:alt: Backers on Open Collective
:target: #backers
.. |ocsponsorbadge| image:: https://opencollective.com/celery/sponsors/badge.svg
:alt: Sponsors on Open Collective
:target: #sponsors
.. |poetry| image:: https://img.shields.io/badge/poetry-yes-blue.svg
:alt: Poetry
:target: https://python-poetry.org/