Skip to content
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 .cookiecutter.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"_commit": "ae33027db848df9540b9fb5735866d070f391bef",
"_commit": "192f7bbb0b7533a90c4fd01209d1d7e387c141f2",
"_template": "C:\\Users\\56kyl\\source\\repos\\cookiecutter-robust-python",
"add_rust_extension": false,
"author": "Kyle Oliver",
Expand Down
4 changes: 2 additions & 2 deletions .cruft.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"template": "C:\\Users\\56kyl\\source\\repos\\cookiecutter-robust-python",
"commit": "ae33027db848df9540b9fb5735866d070f391bef",
"commit": "192f7bbb0b7533a90c4fd01209d1d7e387c141f2",
"checkout": null,
"context": {
"cookiecutter": {
Expand All @@ -20,7 +20,7 @@
"license": "MIT",
"development_status": "Development Status :: 1 - Planning",
"_template": "C:\\Users\\56kyl\\source\\repos\\cookiecutter-robust-python",
"_commit": "ae33027db848df9540b9fb5735866d070f391bef"
"_commit": "192f7bbb0b7533a90c4fd01209d1d7e387c141f2"
}
},
"directory": null
Expand Down
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
## v0.28.0 (2025-11-01)

## v0.27.0 (2025-09-18)

## v0.26.0 (2025-09-18)
Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[56kyleoliver@gmail.com](mailto:56kyleoliver@gmail.com).
[cookiecutter.robust.python@gmail.com](mailto:cookiecutter.robust.python@gmail.com).
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,4 +210,4 @@ _This project was generated from the [cookiecutter-robust-python][cookiecutter-r
[bandit-documentation]: https://bandit.readthedocs.io/
[conventional-commits]: https://www.conventionalcommits.org/
[pytest-documentation]: https://docs.pytest.org/
[cookiecutter-robust-python]: https://github.com/56kyle/cookiecutter-robust-python
[cookiecutter-robust-python]: https://github.com/robust-python/cookiecutter-robust-python
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,5 +91,5 @@ Distributed under the terms of the **MIT** license. See [LICENSE](LICENSE) for d

<!-- Reference Links -->

[cookiecutter-robust-python]: https://github.com/56kyle/cookiecutter-robust-python
[cookiecutter-robust-python]: https://github.com/robust-python/cookiecutter-robust-python
[documentation]: https://robust-python-demo.readthedocs.io/
27 changes: 21 additions & 6 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,18 +45,18 @@
QUALITY: str = "quality"


@nox.session(python=False, name="setup-git", tags=[ENV])
def setup_git(session: Session) -> None:
"""Set up the git repo for the current project."""
session.run("python", SCRIPTS_FOLDER / "setup-git.py", REPO_ROOT, external=True)


@nox.session(python=False, name="setup-venv", tags=[ENV])
def setup_venv(session: Session) -> None:
"""Set up the virtual environment for the current project."""
session.run("python", SCRIPTS_FOLDER / "setup-venv.py", REPO_ROOT, "-p", PYTHON_VERSIONS[0], external=True)


@nox.session(python=False, name="setup-git", tags=[ENV])
def setup_git(session: Session) -> None:
"""Set up the git repo for the current project."""
session.run("python", SCRIPTS_FOLDER / "setup-git.py", REPO_ROOT, external=True)


@nox.session(python=False, name="setup-remote")
def setup_remote(session: Session) -> None:
"""Set up the remote repository for the current project."""
Expand Down Expand Up @@ -156,6 +156,21 @@ def docs_build(session: Session) -> None:
session.log("Building documentation.")
session.run("sphinx-build", "-b", "html", "docs", str(docs_build_dir), "-W")

@nox.session(python=DEFAULT_PYTHON_VERSION, name="docs", tags=[DOCS, BUILD])
def docs(session: Session) -> None:
"""Build and serve the project documentation (Sphinx)."""
session.log("Installing documentation dependencies...")
session.install("-e", ".", "--group", "docs")

session.log(f"Building documentation with py{session.python}.")
docs_build_dir = Path("docs") / "_build" / "html"

session.log(f"Cleaning build directory: {docs_build_dir}")
session.run("sphinx-build", "-b", "html", "docs", str(docs_build_dir), "-E")

session.log("Building and serving documentation.")
session.run("sphinx-autobuild", "--open-browser", "docs", str(docs_build_dir))


@nox.session(python=False, name="build-python", tags=[BUILD])
def build_python(session: Session) -> None:
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "robust-python-demo"
version = "0.27.0"
version = "0.28.0"
description = "robust-python-demo"
authors = [
{ name = "Kyle Oliver", email = "56kyleoliver+cookiecutter-robust-python@gmail.com" },
Expand Down Expand Up @@ -40,6 +40,7 @@ docs = [
"furo>=2024.8.6",
"myst-parser>=3.0.1",
"sphinx>=7.4.7",
"sphinx-autobuild>=2024.10.3",
"sphinx-autodoc-typehints>=2.3.0",
"sphinx-copybutton>=0.5.2",
"sphinx-tabs>=3.4.7",
Expand Down
5 changes: 2 additions & 3 deletions scripts/setup-git.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,9 @@ def setup_git(path: Path) -> None:
commands: list[list[str]] = [
["git", "init"],
["git", "branch", "-m", "master", "main"],
["git", "checkout", "main"],
["git", "checkout", "-b", "develop", "main"],
["git", "add", "."],
["git", "commit", "-m", "feat: initial commit"],
["git", "checkout", "-b", "develop", "main"],
]
check_dependencies(path=path, dependencies=["git"])

Expand All @@ -38,7 +37,7 @@ def get_parser() -> argparse.ArgumentParser:
"""Creates the argument parser for setup-git."""
parser: argparse.ArgumentParser = argparse.ArgumentParser(
prog="setup-git",
usage="python ./scripts/setup-git.py . -u 56kyle -n robust-python-demo",
usage="python ./scripts/setup-git.py . -u robust-python -n robust-python-demo",
description="Set up the provided cookiecutter-robust-python project's git repo.",
)
parser.add_argument(
Expand Down
5 changes: 2 additions & 3 deletions scripts/setup-remote.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,9 @@ def main() -> None:
def setup_remote(path: Path, repository_host: str, repository_path: str) -> None:
"""Set up the provided cookiecutter-robust-python project's git repo."""
commands: list[list[str]] = [
["git", "fetch", "origin"],
["git", "remote", "add", "origin", f"https://{repository_host}/{repository_path}.git"],
["git", "remote", "set-url", "origin", f"https://{repository_host}/{repository_path}.git"],
["git", "pull"],
["git", "fetch", "origin"],
["git", "checkout", "main"],
["git", "push", "-u", "origin", "main"],
["git", "checkout", "develop"],
Expand All @@ -40,7 +39,7 @@ def get_parser() -> argparse.ArgumentParser:
"""Creates the argument parser for setup-remote."""
parser: argparse.ArgumentParser = argparse.ArgumentParser(
prog="setup-remote",
usage="python ./scripts/setup-remote.py . --host github.com --path 56kyle/robust-python-demo",
usage="python ./scripts/setup-remote.py . --host github.com --path robust-python/robust-python-demo",
description="Set up the provided cookiecutter-robust-python project's remote repo connection.",
)
parser.add_argument(
Expand Down
Loading
Loading