diff --git a/.copier-answers.yaml b/.copier-answers.yaml index 484daee..a0943a5 100644 --- a/.copier-answers.yaml +++ b/.copier-answers.yaml @@ -1,8 +1,9 @@ # Changes here will be overwritten by Copier -_commit: c53b04c +_commit: 9642da9 _src_path: https://github.com/python-project-templates/base.git add_docs: false add_extension: python +add_wiki: false email: t.paine154@gmail.com github: python-project-templates project_description: Hatch plugin for C++ builds diff --git a/Makefile b/Makefile index adac7f6..db9ea46 100644 --- a/Makefile +++ b/Makefile @@ -6,6 +6,11 @@ develop: ## install dependencies and build library uv pip install -e .[develop] +requirements: ## install prerequisite python build requirements + python -m pip install --upgrade pip toml + python -m pip install `python -c 'import toml; c = toml.load("pyproject.toml"); print("\n".join(c["build-system"]["requires"]))'` + python -m pip install `python -c 'import toml; c = toml.load("pyproject.toml"); print(" ".join(c["project"]["optional-dependencies"]["develop"]))'` + build: ## build the python library python -m build -n @@ -15,20 +20,27 @@ install: ## install library ######### # LINTS # ######### -.PHONY: lint lints fix format +.PHONY: lint-py lint-docs fix-py fix-docs lint lints fix format -lint: ## run python linter with ruff +lint-py: ## lint python with ruff python -m ruff check hatch_cpp python -m ruff format --check hatch_cpp -# Alias -lints: lint +lint-docs: ## lint docs with mdformat and codespell + python -m mdformat --check README.md + python -m codespell_lib README.md -fix: ## fix python formatting with ruff +fix-py: ## autoformat python code with ruff python -m ruff check --fix hatch_cpp python -m ruff format hatch_cpp -# alias +fix-docs: ## autoformat docs with mdformat and codespell + python -m mdformat README.md + python -m codespell_lib --write README.md + +lint: lint-py lint-docs ## run all linters +lints: lint +fix: fix-py fix-docs ## run all autoformatters format: fix ################ diff --git a/README.md b/README.md index 2d254b9..a468e43 100644 --- a/README.md +++ b/README.md @@ -19,17 +19,19 @@ libraries = [ ``` For more complete systems, see: + - [scikit-build-core](https://github.com/scikit-build/scikit-build-core) - [setuptools](https://setuptools.pypa.io/en/latest/userguide/ext_modules.html) ## Environment Variables -| Name | Default | Description | -|:-----|:--------|:------------| -|`CC`| | | -|`CXX`| | | -|`LD`| | | -|`HATCH_CPP_PLATFORM`| | | -|`HATCH_CPP_DISABLE_CCACHE`| | | + +| Name | Default | Description | +| :------------------------- | :------ | :---------- | +| `CC` | | | +| `CXX` | | | +| `LD` | | | +| `HATCH_CPP_PLATFORM` | | | +| `HATCH_CPP_DISABLE_CCACHE` | | | > [!NOTE] > This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base). diff --git a/pyproject.toml b/pyproject.toml index 5c89714..c494e3b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -42,7 +42,13 @@ develop = [ "build", "bump-my-version", "check-manifest", - "ruff>=0.3,<0.13", + "codespell>=2.4,<2.5", + "hatchling", + "mdformat>=0.7.22,<0.8", + "mdformat-tables>=1", + "pytest", + "pytest-cov", + "ruff", "twine", "uv", "wheel", @@ -68,6 +74,7 @@ Homepage = "https://github.com/python-project-templates/hatch-cpp" current_version = "0.1.7" commit = true tag = false +commit_args = "-s" [[tool.bumpversion.files]] filename = "hatch_cpp/__init__.py"