pytest-celery


Namepytest-celery JSON
Version 1.1.3 PyPI version JSON
download
home_pagehttps://github.com/celery/pytest-celery
SummaryPytest plugin for Celery
upload_time2024-09-20 18:39:57
maintainerNone
docs_urlNone
authorTomer Nosrati
requires_python<4.0,>=3.8
licenseBSD
keywords pytest celery
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
|build-status| |coverage| |license| |semgrep| |pyversion| |pyimp| |ocbackerbadge| |ocsponsorbadge| |poetry|

:Version: v1.1.3
: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`: http://www.opensource.org/licenses/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 <https://docs.celeryq.dev/projects/pytest-celery/en/latest/copyright.html>`_

- `Getting Started`_
    - `Introduction to pytest-celery <https://docs.celeryq.dev/projects/pytest-celery/en/latest/getting-started/introduction.html>`_
    - `First Steps with pytest-celery <https://docs.celeryq.dev/projects/pytest-celery/en/latest/getting-started/first-steps.html>`_
    - `Next Steps <https://docs.celeryq.dev/projects/pytest-celery/en/latest/getting-started/next-steps.html>`_
    - `Vendors <https://docs.celeryq.dev/projects/pytest-celery/en/latest/getting-started/vendors.html>`_
    - `Help <https://docs.celeryq.dev/projects/pytest-celery/en/latest/getting-started/help.html>`_

- `User Guide <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/index.html>`_
    - `Advanced Installation Guide <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/advanced-installation.html>`_
    - `Test Setup Matrix <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/setup-matrix.html>`_
    - `How to prepare the Celery application <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/app-conf.html>`_
    - `How to inject your own utility functions <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/utils-module.html>`_
    - `How to add tasks <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/tasks.html>`_
    - `Built-in Tasks <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/default-tasks.html>`_
    - `How to connect signal handlers <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/signals.html>`_
    - `Standalone Celery Bug Report <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/celery-bug-report.html>`_
    - `Examples <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/examples/index.html>`_
    - `Useful Resources <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/resources/index.html>`_

- `Plugin Development Guide <https://docs.celeryq.dev/projects/pytest-celery/en/latest/devguide/index.html>`_
    - `Local Development Environment <https://docs.celeryq.dev/projects/pytest-celery/en/latest/devguide/local-development-environment.html>`_
    - `Tox Environments <https://docs.celeryq.dev/projects/pytest-celery/en/latest/devguide/tox.html>`_
    - `Sphinx Documentation <https://docs.celeryq.dev/projects/pytest-celery/en/latest/devguide/sphinx.html>`_
    - `How to release a new version <https://docs.celeryq.dev/projects/pytest-celery/en/latest/devguide/release.html>`_

- `API Documentation <https://docs.celeryq.dev/projects/pytest-celery/en/latest/reference/index.html>`_
- `Contributing <https://docs.celeryq.dev/projects/pytest-celery/en/latest/contributing.html>`_
- `FAQ`_
- `Change history <https://docs.celeryq.dev/projects/pytest-celery/en/latest/changelog.html>`_
- `Glossary <https://docs.celeryq.dev/projects/pytest-celery/en/latest/glossary.html>`_

.. |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/

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/celery/pytest-celery",
    "name": "pytest-celery",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": "pytest, celery",
    "author": "Tomer Nosrati",
    "author_email": "tomer.nosrati@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/a3/ed/cf73ad1119f2c9cc009d10a806d21aa165361e4bd04076c76e4f75d51789/pytest_celery-1.1.3.tar.gz",
    "platform": null,
    "description": "\n|build-status| |coverage| |license| |semgrep| |pyversion| |pyimp| |ocbackerbadge| |ocsponsorbadge| |poetry|\n\n:Version: v1.1.3\n:Web: https://pytest-celery.readthedocs.io/en/latest/\n:Download: https://pypi.org/project/pytest-celery/\n:Source: https://github.com/celery/pytest-celery/\n\n===================================\n Official pytest plugin for Celery\n===================================\n\nWelcome to `pytest-celery`_, the official pytest plugin for Celery.\n\n.. _`pytest-celery`: https://pypi.org/project/pytest-celery/\n\nThe pytest-celery plugin introduces significant enhancements with the introduction of\nversion >= 1.0.0, shifting towards a Docker-based approach for smoke and production-like testing.\nWhile the ``celery.contrib.pytest`` API continues to support detailed integration\nand unit testing, the new Docker-based methodology is tailored for testing in\nenvironments that closely mirror production settings.\n\nAdopting version >= 1.0.0 enriches your testing suite with these new capabilities\nwithout affecting your existing tests, allowing for a smooth upgrade path.\nThe documentation here will navigate you through utilizing the Docker-based approach.\nFor information on the ``celery.contrib.pytest`` API for integration and unit testing,\nplease refer to the `official documentation`_.\n\n.. _`official documentation`: https://docs.celeryproject.org/en/latest/userguide/testing.html\n\nThe pytest-celery plugin is Open Source and licensed under the `BSD License`_.\n\n.. _`BSD License`: http://www.opensource.org/licenses/BSD-3-Clause\n\nDonations\n=========\n\nThis project relies on your generous donations.\n\nIf you are using pytest-celery to test a commercial product, please consider becoming\nour `backer`_ or our `sponsor`_ to ensure pytest-celery's future.\n\n.. _`backer`: https://opencollective.com/celery\n.. _`sponsor`: https://opencollective.com/celery\n\nGetting Started\n===============\n\n- If you're new to pytest-celery you can get started by following the `Getting Started`_ tutorial.\n- You can also check out the `FAQ`_.\n\n.. _`Getting Started`: https://docs.celeryq.dev/projects/pytest-celery/en/latest/getting-started/index.html#getting-started\n.. _`FAQ`: https://docs.celeryq.dev/projects/pytest-celery/en/latest/faq.html#faq\n\nContents\n========\n\n- `Copyright <https://docs.celeryq.dev/projects/pytest-celery/en/latest/copyright.html>`_\n\n- `Getting Started`_\n    - `Introduction to pytest-celery <https://docs.celeryq.dev/projects/pytest-celery/en/latest/getting-started/introduction.html>`_\n    - `First Steps with pytest-celery <https://docs.celeryq.dev/projects/pytest-celery/en/latest/getting-started/first-steps.html>`_\n    - `Next Steps <https://docs.celeryq.dev/projects/pytest-celery/en/latest/getting-started/next-steps.html>`_\n    - `Vendors <https://docs.celeryq.dev/projects/pytest-celery/en/latest/getting-started/vendors.html>`_\n    - `Help <https://docs.celeryq.dev/projects/pytest-celery/en/latest/getting-started/help.html>`_\n\n- `User Guide <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/index.html>`_\n    - `Advanced Installation Guide <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/advanced-installation.html>`_\n    - `Test Setup Matrix <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/setup-matrix.html>`_\n    - `How to prepare the Celery application <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/app-conf.html>`_\n    - `How to inject your own utility functions <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/utils-module.html>`_\n    - `How to add tasks <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/tasks.html>`_\n    - `Built-in Tasks <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/default-tasks.html>`_\n    - `How to connect signal handlers <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/signals.html>`_\n    - `Standalone Celery Bug Report <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/celery-bug-report.html>`_\n    - `Examples <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/examples/index.html>`_\n    - `Useful Resources <https://docs.celeryq.dev/projects/pytest-celery/en/latest/userguide/resources/index.html>`_\n\n- `Plugin Development Guide <https://docs.celeryq.dev/projects/pytest-celery/en/latest/devguide/index.html>`_\n    - `Local Development Environment <https://docs.celeryq.dev/projects/pytest-celery/en/latest/devguide/local-development-environment.html>`_\n    - `Tox Environments <https://docs.celeryq.dev/projects/pytest-celery/en/latest/devguide/tox.html>`_\n    - `Sphinx Documentation <https://docs.celeryq.dev/projects/pytest-celery/en/latest/devguide/sphinx.html>`_\n    - `How to release a new version <https://docs.celeryq.dev/projects/pytest-celery/en/latest/devguide/release.html>`_\n\n- `API Documentation <https://docs.celeryq.dev/projects/pytest-celery/en/latest/reference/index.html>`_\n- `Contributing <https://docs.celeryq.dev/projects/pytest-celery/en/latest/contributing.html>`_\n- `FAQ`_\n- `Change history <https://docs.celeryq.dev/projects/pytest-celery/en/latest/changelog.html>`_\n- `Glossary <https://docs.celeryq.dev/projects/pytest-celery/en/latest/glossary.html>`_\n\n.. |build-status| image:: https://github.com/celery/pytest-celery/actions/workflows/python-package.yml/badge.svg\n    :alt: Build status\n    :target: https://github.com/celery/pytest-celery/actions/workflows/python-package.yml\n\n.. |coverage| image:: https://codecov.io/github/celery/pytest-celery/coverage.svg?branch=main\n    :target: https://codecov.io/github/celery/pytest-celery?branch=main\n\n.. |license| image:: https://img.shields.io/pypi/l/pytest-celery.svg\n    :alt: BSD License\n    :target: https://opensource.org/licenses/BSD-3-Clause\n\n.. |semgrep| image:: https://img.shields.io/badge/semgrep-security-green.svg\n    :alt: Semgrep security\n    :target: https://go.semgrep.dev/home\n\n.. |pyversion| image:: https://img.shields.io/pypi/pyversions/pytest-celery.svg\n    :alt: Supported Python versions.\n    :target: https://pypi.org/project/pytest-celery/\n\n.. |pyimp| image:: https://img.shields.io/pypi/implementation/pytest-celery.svg\n    :alt: Supported Python implementations.\n    :target: https://pypi.org/project/pytest-celery/\n\n.. |ocbackerbadge| image:: https://opencollective.com/celery/backers/badge.svg\n    :alt: Backers on Open Collective\n    :target: #backers\n\n.. |ocsponsorbadge| image:: https://opencollective.com/celery/sponsors/badge.svg\n    :alt: Sponsors on Open Collective\n    :target: #sponsors\n\n.. |poetry| image:: https://img.shields.io/badge/poetry-yes-blue.svg\n    :alt: Poetry\n    :target: https://python-poetry.org/\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "Pytest plugin for Celery",
    "version": "1.1.3",
    "project_urls": {
        "Homepage": "https://github.com/celery/pytest-celery"
    },
    "split_keywords": [
        "pytest",
        " celery"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9ca813f300c73143caaf22806953ba0e18b1aef1425357a9070cc2de99101b7c",
                "md5": "672749c5ef640b9a3ec0bb738748d863",
                "sha256": "4cdb5f658dc472509e8be71f745d26bcb8246397661534f5709d2a55edc43286"
            },
            "downloads": -1,
            "filename": "pytest_celery-1.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "672749c5ef640b9a3ec0bb738748d863",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 49032,
            "upload_time": "2024-09-20T18:39:55",
            "upload_time_iso_8601": "2024-09-20T18:39:55.800190Z",
            "url": "https://files.pythonhosted.org/packages/9c/a8/13f300c73143caaf22806953ba0e18b1aef1425357a9070cc2de99101b7c/pytest_celery-1.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a3edcf73ad1119f2c9cc009d10a806d21aa165361e4bd04076c76e4f75d51789",
                "md5": "099dd031d7872d9b7e57287acac82ef1",
                "sha256": "ac7eee546b4d9fb5c742eaaece98187f1f5e5f5622fbaa8e7729bb46923c54fc"
            },
            "downloads": -1,
            "filename": "pytest_celery-1.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "099dd031d7872d9b7e57287acac82ef1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 29770,
            "upload_time": "2024-09-20T18:39:57",
            "upload_time_iso_8601": "2024-09-20T18:39:57.869891Z",
            "url": "https://files.pythonhosted.org/packages/a3/ed/cf73ad1119f2c9cc009d10a806d21aa165361e4bd04076c76e4f75d51789/pytest_celery-1.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-20 18:39:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "celery",
    "github_project": "pytest-celery",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "pytest-celery"
}
        
Elapsed time: 4.01688s