Metadata in pyproject.toml

Author: esdandreu

.github/workflows/release.yml .github/workflows/cd.yml.github/workflows/release.yml renamed to .github/workflows/cd.yml

@@ -1,90 +1,110 @@
 # Python C++ extension
+
 A template for a standalone C++ library with dependencies managed by
 [vcpkg](https://github.com/microsoft/vcpkg) accessible through Python using
 [pybind11](https://github.com/pybind/pybind11).
 
 ## Why should I use this template?
-- You want to write a C++ library that can be accessed through Python.
-- You want to use `cmake` to build your C++ code.
-- You want to use `pybind11` to expose your C++ library as a Python module.
-- You want to use some C++ dependencies and manage them with `vcpkg`. Otherwise
+
+* You want to write a C++ library that can be accessed through Python.
+* You want to use `cmake` to build your C++ code.
+* You want to use `pybind11` to expose your C++ library as a Python module.
+* You want to use some C++ dependencies and manage them with `vcpkg`. Otherwise
   you should check other [scikit-build sample
   projects](https://github.com/scikit-build/scikit-build-sample-projects).
-- You are not specially concerned about build and install optimizations, it is
+* You are not specially concerned about build and install optimizations, it is
   not a problem if they are long running.
 
 If you want to distribute your extension using `pip` or `conda` and you mind
 that your users take a long time to install it, then it might be better to
 distribute some built binaries instead of optimizing the build process. This
 template might still be useful for you as it has a
-[release](.github/workflows/release.yml) workflow for building python wheels
-with [cibuildwheel](https://github.com/pypa/cibuildwheel) and distributing them
-to [PyPI](https://pypi.org/).
+[CD](.github/workflows/cd.yml) workflow for building python wheels
+with [cibuildwheel](https://github.com/pypa/cibuildwheel) and uploading them to
+[PyPI](https://pypi.org/).
 
 ## Example usage
 
 ### Create a clean Python virtual environment
+
 ```
 python -m venv venv
 ```
+
 Activate it on Windows
+
 ```
 .\venv\Scripts\activate
 ```
+
 otherwise
+
 ```
 source ./venv/bin/activate
 ```
 
 ### Install this project
+
 ```
 pip install git+https://github.com/esdandreu/python-extension-cpp
 ```
-It will take a while to build as it will build the C++ dependencies as well,
+
+It will take a while to build as it will build the C++ dependencies as well, 
 but it will work. It is definitely not the most optimal way of installing a
 package as we are installing as well the `vcpkg` package manager and building
 from source dependencies that might as well be installed on the system. But
 this allows a fast development environment where adding or removing C++
 dependencies should be easy.
 
-Alternatively, you can install the package from the binaries distributed in [PyPI](https://pypi.org/project/example-python-extension-cpp/).
+Alternatively, you can install the package from the binaries distributed in
+[PyPI](https://pypi.org/project/example-python-extension-cpp/) using the
+[continuous deployment](#cicd) workflow.
+
 ```
 pip install example-python-extension-cpp
 ```
 
 ### Test that the C++ code is working in the Python package
+
 Our simple project contains a `add` function that adds two numbers together.
+
 ```
 python -c "import my_python_api; print(my_python_api.add(1, 2))"
 ```
 
 It also makes use of the C++ library
 [fftw3](https://github.com/FFTW/fftw3.git) that is available through `vcpkg`
+
 in order to perform a Fast Fourier Transform over a generated signal, printing
 its results.
+
 ```
 python -c "import my_python_api; my_python_api.hello_fft()"
 ```
 
 ## Setup
+
 ### Install the requirements
 Install [vcpkg](https://github.com/microsoft/vcpkg) requirements with the
 addition of `cmake` and Python. It could be summarized as:
-- [git](https://git-scm.com/downloads)
-- Build tools ([Visual
+* [git](https://git-scm.com/downloads)
+* Build tools ([Visual
   Studio](https://docs.microsoft.com/en-us/visualstudio/install/install-visual-studio)
   on Windows or `gcc` on Linux for example)
-- [cmake](#cmake)
-- Python. Make sure to have development tools installed (`python3.X-dev` on
+* [cmake](#cmake)
+* Python. Make sure to have development tools installed (`python3.X-dev` on
   Linux, being `X` your version of Python).
 
 If running on a clean linux environment (like a container or Windows Subsystem
 for Linux) you will need to install some additional tools as it is stated in
-`vcpkg`.
+`vcpkg` .
+
 ```
 sudo apt-get install build-essential curl zip unzip tar pkg-config libssl-dev python3-dev
 ```
+
 #### CMake
+
 Follow the [official instructions](https://cmake.org/install/).
 
 The required `cmake` version is quite high, if you are using a Linux
@@ -95,10 +115,11 @@ line](https://askubuntu.com/a/865294).
 
 Make sure that when you run `cmake --version` the output is `3.21` or higher.
 The reason for this is that we are using some of the `3.21` features to install
-runtime dependencies (managed with `vcpkg`) together with our project so they
+runtime dependencies (managed with `vcpkg` ) together with our project so they
 are available to Python when using its API.
 
 #### Formatters
+
 This project uses `clang-format` to format the C++ code. There is a
 `.clang-format` file with options that I personally like. Download
 `clang-format` as part of `LLVM` from the official [release
@@ -109,40 +130,48 @@ I als recommend using `yapf` to format python code.
 ### Clone this repository with `vcpkg`
 
 Cone this repository with `vcpkg` as a submodule and navigate into it.
+
 ```
 git clone --recursive git@github.com:esdandreu/python-extension-cpp.git
 cd python-extension-cpp
 ```
 
 Bootstrap `vcpkg` in Windows. Make sure you have [installed the
 prerequisites](https://github.com/microsoft/vcpkg).
+
 ```
 .\vcpkg\bootstrap-vcpkg.bat
 ```
 
 Or in Linux/MacOS. Make sure you have [installed developer
 tools](https://github.com/microsoft/vcpkg)
+
 ```
 ./vcpkg/bootstrap-vcpkg.sh
 ```
 
 ## Building
 
 ### Build locally with CMake
+
 Navigate to the root of the repository and create a build directory.
+
 ```
 mkdir build
 ```
 
-Configure `cmake` to use `vcpkg`.
+Configure `cmake` to use `vcpkg` .
+
 ```
 cmake -B build -S . -DCMAKE_TOOLCHAIN_FILE="$pwd/vcpkg/scripts/buildsystems/vcpkg.cmake"
 ```
 
 Build the project.
+
 ```
 cmake --build build
 ```
+
 ### Build locally with Python
 
 It is recommended to use a [clean virtual
@@ -158,11 +187,11 @@ pip install scikit-build git
 
 Install the repository. By adding `[test]` to our install command we can
 install additionally the test dependencies.
+
 ```
 pip install .[test]
 ```
 
-
 ## Testing
 
 ### Test the C++ library with Google Test
@@ -180,16 +209,16 @@ pytest
 ## CI/CD
 
 This template contains a continuous integration workflow that builds and tests
-the C++ library and the python extension
-[test.yml](.github/workflows/test.yml).
+the C++ library and the python extension [ci.yml](.github/workflows/ci.yml).
 
 It also contains a continuous deployment workflow that builds wheels and source
 distributions for the python extension, then creates a github release with it
 and uploads it to [PyPI](https://pypi.org/):
-[release.yml](.github/workflows/release.yml). That workflow requires a
-repository secret named `PYPI_TOKEN` with a PyPI API token. is activated when
-pushing a version tag to the repository:
+[cd.yml](.github/workflows/cd.yml). That workflow requires a repository secret
+named `PYPI_TOKEN` with a PyPI API token. is activated when pushing a version
+tag to the repository:
+
 ```
 git tag -a v0.0.1 -m "First release"
 git push origin --tags
-```
+```

.github/workflows/test.yml .github/workflows/ci.yml.github/workflows/test.yml renamed to .github/workflows/ci.yml

@@ -7,9 +7,32 @@ requires = [
     "pybind11",
     "GitPython",
 ]
-
 build-backend = "setuptools.build_meta"
 
+[project]
+# https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
+# https://peps.python.org/pep-0621/
+name = "example-python-extension-cpp"
+authors = [
+    { name = "Andreu Gimenez", email = "esdandreu@gmail.com" },
+]
+description = "A minimal C++ extension using pybind11 and vcpkg"
+readme = "README.md"
+license = {text = "BSD 3-Clause License"}
+requires-python = ">=3.7"
+keywords = ["example", "vcpkg", "pybind11", "scikit-build", "cpp"]
+dynamic = ["version"] 
+
+[project.urls]
+homepage = "https://github.com/esdandreu/python-extension-cpp"
+repository = "https://github.com/esdandreu/python-extension-cpp"
+
+[project.optional-dependencies]
+# When adding `[test]` to your `pip install` command you can install the extra
+# dependencies associated with testing. Example `pip install .[test]`
+# https://setuptools.pypa.io/en/latest/userguide/dependency_management.html#optional-dependencies
+test = ["pytest"]
+
 [tool.pytest.ini_options]
 minversion = "6.0"
 testpaths = [

README.md

@@ -1,3 +1,17 @@
+"""Build setup
+
+Setup the build environment for a C++ python extension module with `vcpkg` as
+C++ package manager. It uses `scikit-build` to build the C++ extension module
+and `GitPython` to pull `vcpkg` when it is defined as a submodule (as it is
+recommended).
+
+It is recommended to set the package metadata in the file `pyproject.toml`
+minimizing the amount of package specific configuration in this file.
+
+Raises:
+    RuntimeError: If `vcpkg` is not a submodule of the repository.
+"""
+
 import warnings
 import json
 import sys
@@ -55,8 +69,7 @@
     PROJECT_VERSION_STRING = vcpkg_json["version-string"]
     # A different name can be specified here in order to upload to PyPI with a
     # project name different than the module name.
-    # PROJECT_NAME = vcpkg_json["name"]
-    PROJECT_NAME = 'example-python-extension-cpp' 
+    PROJECT_NAME = vcpkg_json["name"]
 
 # scikit-build will take care of puting our compiled C++ library together with
 # our python package so it can access it. The name of the python package will
@@ -75,13 +88,9 @@
         )
 
 setup(
-    # Python package information, can be edited
-    name=PROJECT_NAME,
-    version=PROJECT_VERSION_STRING,
-    description="A minimal C++ extension using pybind11 and vcpkg",
-    author="Andreu Gimenez",
-    license="MIT",
-    # Python package information is defined above
+    # Package metadata, comment out if it is provided in `pyproject.toml`.
+    # name=PROJECT_NAME, # Use the name defined in `vcpkg.json`
+    version=PROJECT_VERSION_STRING, # Set version from `vcpkg.json`
     packages=packages,
     package_dir={"": python_packages_root},
     cmake_install_dir=python_packages_root + "/" + packages[0],
@@ -94,13 +103,4 @@
         "-DBUILD_PYTHON_API=ON",
         "-DBUILD_TESTS=OFF",
         ],
-    # Extra setuptools keywords:
-    # https://setuptools.pypa.io/en/latest/userguide/keywords.html
-    python_requires=">=3.7",
-    # When adding `[test]` to your `pip install` command you can install the
-    # extra dependencies associated with testing. Example `pip install .[test]`
-    # https://setuptools.pypa.io/en/latest/userguide/dependency_management.html#optional-dependencies
-    extras_require={"test": ["pytest"]},
-    # Necessary to publish to PyPi with the README.md as the long description
-    long_description_content_type="text/markdown",
 )