Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change: Removed "celery" extra #221

Merged
merged 1 commit into from
Feb 28, 2024
Merged
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
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ build:
# Tell poetry to not use a virtual environment
- poetry config virtualenvs.create false
post_install:
- poetry install -E "celery" --with docs
- poetry install --with docs

# Build documentation in the "docs/" directory with Sphinx
sphinx:
Expand Down
6 changes: 1 addition & 5 deletions docs/getting-started/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,7 @@ What do I need?

- Python ❨3.8, 3.9, 3.10, 3.11, 3.12❩

Celery is required and may be installed separately or automatically using the `celery` extra.
When used with the `celery` extra, pytest-celery will install the latest version of Celery
and a predefined set of extras.

Pytest Celery is Celery-agnostic, and should work with virtually any version of Celery.
The pytest-celery plugin is Celery-agnostic, and should work with virtually any version of Celery.

.. warning::
Currently, due to limited resources, we are unable to officially support Microsoft Windows.
Expand Down
9 changes: 3 additions & 6 deletions docs/includes/installation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,16 @@
Installation
============

You can install Pytest Celery either via the Python Package Index (PyPI).
You can install Pytest Celery via the Python Package Index (PyPI).

To install using :command:`pip`:

.. code-block:: console

$ pip install -U pytest-celery

To include the latest celery package, install with the ``celery`` extra:

.. code-block:: console

$ pip install -U "pytest-celery[celery]"
The :pypi:`celery` package will be installed by default with the ``redis`` and ``pymemcache``
`extras <https://docs.celeryq.dev/en/stable/getting-started/introduction.html#transports-and-backends>`_.

With git
~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion examples/django/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
sqlalchemy>=1.2.18
django>=2.2.1
pytest-django>=4.7.0
pytest-celery[celery]@git+https://github.com/celery/pytest-celery.git
git+https://github.com/celery/pytest-celery.git
pytest-xdist>=3.5.0
2 changes: 1 addition & 1 deletion examples/myutils/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
pytest>=7.4.4
pytest-celery[celery]@git+https://github.com/celery/pytest-celery.git
git+https://github.com/celery/pytest-celery.git
pytest-xdist>=3.5.0
2 changes: 1 addition & 1 deletion examples/myworker/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
pytest>=7.4.4
pytest-celery[celery]@git+https://github.com/celery/pytest-celery.git
git+https://github.com/celery/pytest-celery.git
pytest-xdist>=3.5.0
2 changes: 1 addition & 1 deletion examples/rabbitmq_management/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
pytest>=7.4.4
pytest-celery[celery]@git+https://github.com/celery/pytest-celery.git
git+https://github.com/celery/pytest-celery.git
pytest-xdist>=3.5.0
2 changes: 1 addition & 1 deletion examples/range/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
pytest>=7.4.4
pytest-celery[celery]@git+https://github.com/celery/pytest-celery.git
git+https://github.com/celery/pytest-celery.git
pytest-xdist>=3.5.0
pytest-subtests>=0.11.0
45 changes: 21 additions & 24 deletions poetry.lock

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

8 changes: 1 addition & 7 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -72,20 +72,14 @@ search = ':Version: {current_version}'
replace = ':Version: {new_version}'

[tool.poetry.dependencies]
celery = { version = "^5.0.0", extras = ["redis", "pymemcache"] }
python = ">= 3.8,<4.0"
celery = { version = "<6.0.0", extras = [
"redis",
"pymemcache",
], optional = true }
retry = "^0.9.2"
pytest-docker-tools = "^3.1.3"
docker = "^7.0.0"
psutil = "^5.9.7"
setuptools = "^69.1.0"

[tool.poetry.extras]
celery = ["celery"]

[tool.poetry.group.dev]

[tool.poetry.group.dev.dependencies]
Expand Down
14 changes: 7 additions & 7 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ setenv =
PYTHONUNBUFFERED = 1
PYTHONDONTWRITEBYTECODE = 1
commands_pre =
poetry install -E "celery" --with test
poetry install --with test
commands =
unit: poetry run pytest tests/unit/ --maxfail=3 {posargs}
integration: poetry run pytest tests/integration/ --exitfirst --dist=loadscope {posargs}
Expand All @@ -51,7 +51,7 @@ setenv =
PYTHONUNBUFFERED = 1
PYTHONDONTWRITEBYTECODE = 1
commands_pre =
poetry install -E "celery" --with test
poetry install --with test
commands =
poetry run pytest tests --exitfirst \
-n auto --dist=loadscope \
Expand All @@ -64,7 +64,7 @@ setenv =
PYTHONUNBUFFERED = 1
PYTHONDONTWRITEBYTECODE = 1
commands_pre =
poetry install -E "celery" --with test
poetry install --with test
commands =
tox -e py312-unit,py312-integration,py312-smoke -p auto -o -- --exitfirst \
-n auto --dist=loadscope \
Expand All @@ -83,7 +83,7 @@ commands =
description = Run code+doc lint using {basepython}
allowlist_externals = poetry, make
commands_pre =
poetry install -E "celery" --with dev,docs
poetry install --with dev,docs
commands =
poetry run pre-commit {posargs:run --all-files --show-diff-on-failure}
make -C ./docs apicheck
Expand All @@ -107,22 +107,22 @@ commands =
description = Build docs using {basepython}
allowlist_externals = poetry, make
commands_pre =
poetry install -E "celery" --with docs
poetry install --with docs
commands =
make -C ./docs html

[testenv:docs-livehtml]
description = Build docs using {basepython} and serve in http://0.0.0.0:7010
allowlist_externals = poetry, make
commands_pre =
poetry install -E "celery" --with docs
poetry install --with docs
commands =
make -C ./docs livehtml

[testenv:docs-apidoc]
description = Regenerate API Reference doc section using {basepython}
allowlist_externals = poetry, make
commands_pre =
poetry install -E "celery" --with docs
poetry install --with docs
commands =
make -C ./docs apidoc
Loading