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
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ jobs:

- name: Install the Python dependencies without debugpy
run: |
pip install .[test]
pip install . --group test
pip uninstall --yes debugpy

- name: List installed packages
Expand Down
12 changes: 4 additions & 8 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,10 @@ build:
os: ubuntu-22.04
tools:
python: "3.13"
jobs:
install:
- pip install --upgrade pip
- pip install --group docs

sphinx:
configuration: docs/conf.py

python:
install:
# install itself with pip install .
- method: pip
path: .
extra_requirements:
- docs
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ ipykernel is a pure Python package, so setting up for development is the same as
git clone https://github.com/ipython/ipykernel
cd ipykernel
# do a 'development' or 'editable' install with pip:
pip install -e .
pip install -e . --group dev
```

## Code Styling
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This package provides the IPython kernel for Jupyter.

1. `git clone`
1. `cd ipykernel`
1. `pip install -e ".[test]"`
1. `pip install -e . --group test`

After that, all normal `ipython` commands will use this newly-installed version of the kernel.

Expand Down
45 changes: 25 additions & 20 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -41,35 +41,40 @@ Source = "https://github.com/ipython/ipykernel"
Tracker = "https://github.com/ipython/ipykernel/issues"

[project.optional-dependencies]
pyqt5 = ["pyqt5"]
pyside6 = ["pyside6"]

[dependency-groups]
docs = [
"sphinx",
"myst_parser",
"pydata_sphinx_theme",
"sphinxcontrib_github_alt",
"sphinxcontrib-spelling",
"sphinx-autodoc-typehints",
"intersphinx_registry",
"trio"
"intersphinx_registry",
"myst_parser",
"pydata_sphinx_theme",
"sphinx",
"sphinxcontrib_github_alt",
"sphinxcontrib-spelling",
"sphinx-autodoc-typehints",
"trio"
]
test = [
"pytest>=7.0,<10",
"pytest-cov",
# 'pytest-xvfb; platform_system == "Linux"',
"flaky",
"ipyparallel",
"pre-commit",
"psutil>=5.7",
"pytest>=7.0,<10",
"pytest-cov",
"pytest-asyncio>=0.23.5",
"pytest-timeout"
]
cov = [
"coverage[toml]",
"pytest-cov",
"matplotlib",
"trio",
"coverage[toml]",
"matplotlib",
"pytest-cov",
"trio",
]
dev = [
"pre-commit",
{include-group = "test"},
]
pyqt5 = ["pyqt5"]
pyside6 = ["pyside6"]

[tool.hatch.version]
path = "ipykernel/_version.py"
Expand All @@ -84,20 +89,20 @@ path = "ipykernel/_version.py"
"./ipykernel_launcher.py" = "ipykernel_launcher.py"

[tool.hatch.envs.docs]
features = ["docs"]
dependency-groups = ["docs"]
[tool.hatch.envs.docs.scripts]
build = "make -C docs html SPHINXOPTS='-W'"
api = "sphinx-apidoc -o docs/api -f -E ipykernel tests ipykernel/datapub.py ipykernel/pickleutil.py ipykernel/serialize.py ipykernel/gui ipykernel/pylab ipykernel/utils.py"

[tool.hatch.envs.test]
features = ["test"]
dependency-groups = ["test"]
[tool.hatch.envs.test.scripts]
list = "python -m pip freeze"
test = "python -m pytest -vv {args}"
nowarn = "test -W default {args}"

[tool.hatch.envs.cov]
features = ["test", "cov"]
dependency-groups = ["test", "cov"]
[tool.hatch.envs.cov.scripts]
test = "python -m pytest -vv --cov ipykernel --cov-branch --cov-report term-missing:skip-covered {args}"
nowarn = "test -W default {args}"
Expand Down
Loading