Skip to content

chore(patch-release): misc refinements #896

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

Merged
merged 6 commits into from
Jan 31, 2025
Merged

chore(patch-release): misc refinements #896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b68bfa5
chore(patch-release): misc refinements
huxuan Jan 31, 2025
3b4ed23
add version_option to command group
huxuan Jan 31, 2025
26e4361
specify package versions
huxuan Jan 31, 2025
ddbbfbc
format
huxuan Jan 31, 2025
8706ee9
update lockfiles
huxuan Jan 31, 2025
23098f7
update template
huxuan Jan 31, 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
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ doc-watch:

# Build documentation only from src.
doc-build:
pdm run sphinx-build -a docs $(PUBLIC_DIR)
pdm run sphinx-build --fail-on-warning --write-all docs $(PUBLIC_DIR)

# Generate html coverage reports with badge.
doc-coverage: test-run
Expand Down
2 changes: 1 addition & 1 deletion pdm.dev.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
groups = ["doc", "lint", "test"]
strategy = ["inherit_metadata"]
lock_version = "4.5.0"
content_hash = "sha256:bb122c24e17decd9d1d6c8b6bf2bad444717e0ca671e262ed2ddde2be4851df2"
content_hash = "sha256:3b3cf93a57ae97f3f868cff27773abbd10f762b7d68b0a1bc24e1656994431e9"

[[metadata.targets]]
requires_python = ">=3.9"
Expand Down
2 changes: 1 addition & 1 deletion pdm.lock
View file
Open in desktop

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

28 changes: 14 additions & 14 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ dynamic = [
"version",
]
dependencies = [
"click",
"pydantic-settings",
"click>=8.1.8",
"pydantic-settings>=2.7.1",
]
urls.documentation = "https://serious-scaffold.github.io/ss-python"
urls.issue = "https://github.com/serious-scaffold/ss-python/issues"
Expand All @@ -47,22 +47,22 @@ scripts.ss-python-cli = "ss_python.cli:cli"

[dependency-groups]
test = [
"coverage",
"pytest",
"coverage>=7.6.10",
"pytest>=8.3.4",
]
doc = [
"autodoc-pydantic",
"coverage",
"furo",
"mypy[reports]",
"myst-parser",
"pytest",
"sphinx",
"sphinx-click",
"sphinx-design",
"autodoc-pydantic>=2.2.0",
"coverage>=7.6.10",
"furo>=2024.8.6",
"mypy[reports]>=1.14.1",
"myst-parser>=3.0.1",
"pytest>=8.3.4",
"sphinx>=7.4.7",
"sphinx-click>=6.0.0",
"sphinx-design>=0.6.1",
]
lint = [
"mypy",
"mypy>=1.14.1",
]

[tool.pdm]
Expand Down
1 change: 1 addition & 0 deletions src/ss_python/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@


@click.group()
@click.version_option()
def cli() -> None:
"""CLI for Serious Scaffold Python."""

Expand Down
2 changes: 1 addition & 1 deletion template/Makefile.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ doc-watch:

# Build documentation only from src.
doc-build:
pdm run sphinx-build -a docs $(PUBLIC_DIR)
pdm run sphinx-build --fail-on-warning --write-all docs $(PUBLIC_DIR)

# Generate html coverage reports with badge.
doc-coverage: test-run
Expand Down
28 changes: 14 additions & 14 deletions template/pyproject.toml.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ dynamic = [
"version",
]
dependencies = [
"click",
"pydantic-settings",
"click>=8.1.8",
"pydantic-settings>=2.7.1",
]
urls.documentation = "https://{{ page_url() }}"
{% if repo_platform == 'github' %}
Expand All @@ -92,22 +92,22 @@ scripts.{{ package_name }}-cli = "{{ module_name }}.cli:cli"

[dependency-groups]
test = [
"coverage",
"pytest",
"coverage>=7.6.10",
"pytest>=8.3.4",
]
doc = [
"autodoc-pydantic",
"coverage",
"furo",
"mypy[reports]",
"myst-parser",
"pytest",
"sphinx",
"sphinx-click",
"sphinx-design",
"autodoc-pydantic>=2.2.0",
"coverage>=7.6.10",
"furo>=2024.8.6",
"mypy[reports]>=1.14.1",
"myst-parser>=3.0.1",
"pytest>=8.3.4",
"sphinx>=7.4.7",
"sphinx-click>=6.0.0",
"sphinx-design>=0.6.1",
]
lint = [
"mypy",
"mypy>=1.14.1",
]

[tool.pdm]
Expand Down
1 change: 1 addition & 0 deletions template/src/{{ module_name }}/cli.py.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import click


@click.group()
@click.version_option()
def cli() -> None:
"""CLI for {{ project_name }}."""

Expand Down