Skip to content

Various improvements to pyproject toml #23

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.

Sign up for GitHub

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

Closed
caspervdw wants to merge 2 commits into from
Closed

Various improvements to pyproject toml #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac71ca2
Various improvements to p yproject toml
caspervdw Sep 16, 2025
24f4658
Revert and fix
caspervdw Sep 16, 2025
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
1 change: 1 addition & 0 deletions {{ cookiecutter.project_name }}/.github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ on:
push:
branches:
- master
- main
Copy link
Member

@reinout reinout Sep 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually want to remove the whole test.yml, I accidentally left that one in. The basic nens-meta.yml covers a quick pytest call.

Copy link
Member

@reinout reinout Sep 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in #25

pull_request:

jobs:
Expand Down
13 changes: 7 additions & 6 deletions {{ cookiecutter.project_name }}/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ keywords = []
requires-python = ">=3.12"
dependencies = []

[project.optional-dependencies]
test = ["pytest>=8.4.2", "pytest-cov>=6.3.0", "pytest-sugar>=1.1.1"]

Comment on lines +21 to +23
Copy link
Member

@reinout reinout Sep 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I need to do a bit of googling on this. I've automatically been using uv's install --dev, but I might need to change that.

[project.urls]
homepage = "https://github.com/nens/{{ cookiecutter.project_name }}"

[tool.pytest.ini_options]
addopts = "--cov --cov-fail-under=80"

Comment on lines -24 to -26
Copy link
Member

@reinout reinout Sep 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good one. I had forgotten that it breaks vscode.
A bummer, as this setting is a nice way to customise the waypytest runs in the github action without having to make changes to the generated gh action file.

Copy link
Member

@reinout reinout Sep 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm adding a comment to mostly fix this: https://github.com/nens/cookiecutter-python-template/pull/25/files#diff-fc2fadee46a6a3ade3b8d0faee076978577745ccba23a0b1fb8f6483d0fa8b2c

[tool.zest-releaser]
release = false

Expand All @@ -38,13 +38,14 @@ select = ["E4", "E7", "E9", "F", "I", "UP", "C901"]
[tool.ruff.lint.isort]
known-first-party = ["{{ cookiecutter.package_name }}"]


[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["F401", "F403"]
Comment on lines +42 to +43
Copy link
Member

@reinout reinout Sep 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer not to have it in the basic template. It is fine for properly build and maintained APIs, but advisors will also use this template and they have the tendency to make an unholy mess with import * in init files.

Easy to enable/add for individual projects that need it.

Copy link
Member

@reinout reinout Sep 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documented it in nens/nens-meta@3a9fa0c


[tool.pyright]
# Pyright/pylance/vscode configuration.
# Note: if you want a different setup, you can overwrite this with a
# "pyrightconfig.json", which takes precedence.
include = "src"
venvPath = "."
venv = ".venv"

[dependency-groups]
dev = ["pytest>=8.4.2", "pytest-cov>=6.3.0", "pytest-sugar>=1.1.1"]
Loading