Modernize project to use pyproject.toml

Author: jbcoe

.pre-commit-config.yaml

@@ -25,7 +25,6 @@ repos:
   - id: check-yaml
   - id: end-of-file-fixer
   - id: forbid-submodules
-  - id: requirements-txt-fixer
   - id: trailing-whitespace
 - repo: https://github.com/pre-commit/mirrors-clang-format
   rev: v18.1.2

DEVELOPMENT.md

@@ -8,10 +8,8 @@ install a virtual environment with pre-commmit set up, and then use precommit to
 install git hooks it to your local repository:
 
 ```bash
-python3 -m venv .venv           # Create a Python virtual env
-source ./.venv/bin/activate     # Activate the virtual env for bash by source.
-pip install -r requirements.txt # Install latest requirements including pre-commit
-pre-commit install              # Use pre-commit to install git hooks into the working repository.
+uv sync                         # Install dependencies
+uv run pre-commit install       # Use pre-commit to install git hooks into the working repository.
 ```
 
 pre-commit is configured with .pre-commit-config.yaml which contains some

README.md

@@ -19,16 +19,24 @@ simple Python model of a C++ translation unit.
 Currently the environment variable `PY_CPPMODEL_LIBCLANG_PATH` must be defined
 to specify where libclang can be found. This may be fixed in the future.
 
-## Testing
+## Development
+
+To set up the development environment, execute the following commands:
+
+```sh
+uv sync
+```
 
 To run the tests, run:
 
 ```sh
-python3 -m venv .venv           # Create a Python virtual env.
-source ./.venv/bin/activate     # Activate the virtual env for bash by source.
+uv run python -m unittest discover .
+```
+
+To run type checking:
 
-mypy *.py --check-untyped-defs  # Run mypy to check type hints.
-unittest discover .             # Run tests.
+```sh
+uv run mypy *.py --check-untyped-defs
 ```
 
 ## Attribution

pyproject.toml

@@ -0,0 +1,54 @@
+[project]
+name = "py-cppmodel"
+version = "0.0.1"
+description = "A Python wrapper around clang's python bindings to generate a simple Python model of a C++ translation unit."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { file = "LICENSE" }
+authors = [{ name = "J.B. Coe", email = "jonathanbcoe@gmail.com" }]
+dependencies = [
+    "clang>=14.0",
+]
+
+[project.urls]
+Repository = "https://github.com/jbcoe/py_cppmodel"
+
+[project.optional-dependencies]
+dev = [
+    "mypy",
+    "parameterized",
+    "pre-commit",
+    "pytype",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "py_cppmodel.py",
+    "LICENSE",
+    "README.md",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["."]
+exclude = [
+    "*.sh",
+    "*.ipynb",
+    "test_*.py",
+    "requirements.txt",
+    "mypy.ini",
+    "Sandbox.ipynb",
+    ".github",
+]
+
+[dependency-groups]
+dev = [
+    "ipython>=8.12.3",
+    "jupyter>=1.1.1",
+    "parameterized>=0.9.0",
+    "pre-commit>=4.5.1",
+    "pytest>=8.3.5",
+]

requirements.txt

@@ -1,13 +1,11 @@
 #!/usr/bin/env bash
 
-# Virtual environment setup
-python3 -m venv .venv           # Create a Python virtual env
-source ./.venv/bin/activate     # Activate the virtual env for bash by source.
-python3 -m pip install -r requirements.txt # Install latest requirements.
+# Install dependencies
+uv sync
 
 # Type checks
-python3 -m mypy *.py --check-untyped-defs  # Run mypy to check type hints
+uv run mypy *.py --check-untyped-defs  # Run mypy to check type hints
 
 # Unit tests
 PY_CPPMODEL_LIBCLANG_PATH=/Library/Developer/CommandLineTools/usr/lib/libclang.dylib \
-python3 -m unittest discover --verbose .             # Run tests
+uv run python3 -m unittest discover --verbose .             # Run tests

test.macos.sh

@@ -3,8 +3,6 @@
 import py_cppmodel
 import unittest
 
-from ctypes.util import find_library
-
 LIBCLANG_PATH = os.environ.get("PY_CPPMODEL_LIBCLANG_PATH")
 if not LIBCLANG_PATH:
     raise RuntimeError("PY_CPPMODEL_LIBCLANG_PATH is unset")