Move all metadata to pyproject.toml (#1026)

.github/workflows/python-publish.yml

@@ -20,11 +20,11 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install setuptools wheel twine
+        pip install build twine
     - name: Build and publish
       env:
         TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
         TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
       run: |
-        python setup.py sdist bdist_wheel
+        python -m build
         twine upload dist/*

docs/dev_guide.md

@@ -210,7 +210,7 @@ is located at `floris/.github/workflows/continuous-integration-workflow.yaml`.
 The online documentation is built with Jupyter Book which uses Sphinx
 as a framework. It is automatically built and hosted by GitHub, but it
 can also be compiled locally. Additional dependencies are required
-for the documentation, and they are listed in the `EXTRAS` of `setup.py`.
+for the documentation, and they are listed in the `project.optional-dependencies` of `pyproject.toml`.
 The commands to build the docs are given below. After successfully
 compiling, a file should be located at ``docs/_build/html/index.html``.
 This file can be opened in any browser.
@@ -246,7 +246,7 @@ Be sure to complete each step in the sequence as described.
     with a commit message such as "Update version to vN.M".
     The version number must be updated in the following two files:
     - [floris/README.md](https://github.com/NREL/floris/blob/main/README.md)
-    - [floris/floris/version.py](https://github.com/NREL/floris/blob/main/floris/version.py)
+    - [pyproject.toml](https://github.com/NREL/floris/blob/main/pyproject.toml)
     Note that a `.0` version number is left off meaning that valid versions
     are `v3`, `v3.1`, `v3.1.1`, etc.
 

floris/__init__.py

@@ -1,9 +1,9 @@
 
+from importlib.metadata import version
 from pathlib import Path
 
 
-with open(Path(__file__).parent / "version.py") as _version_file:
-    __version__ = _version_file.read().strip()
+__version__ = version("floris")
 
 
 from .floris_model import FlorisModel

pyproject.toml

@@ -2,6 +2,71 @@
 requires = ["setuptools >= 40.6.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
+[project]
+name = "floris"
+version = "4.2"
+description = "A controls-oriented engineering wake model."
+readme = "README.md"
+requires-python = ">=3.8"
+authors = [
+    { name = "Rafael Mudafort", email = "[email protected]" },
+    { name = "Paul Fleming", email = "[email protected]" },
+    { name = "Michael (Misha) Sinner", email = "[email protected]" },
+    { name = "Eric Simley", email = "[email protected]" },
+    { name = "Christopher Bay", email = "[email protected]" },
+]
+license = { file = "LICENSE.txt" }
+keywords = ["floris"]
+classifiers = [
+        "License :: OSI Approved :: BSD License",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: Implementation :: CPython",
+        "Programming Language :: Python :: Implementation :: PyPy"
+]
+dependencies = [
+    "attrs",
+    "pyyaml~=6.0",
+    "numexpr~=2.0",
+    "numpy~=1.20",
+    "scipy~=1.1",
+    "matplotlib~=3.0",
+    "pandas~=2.0",
+    "shapely~=2.0",
+    "coloredlogs~=15.0",
+    "pathos~=0.3",
+]
+
+[project.optional-dependencies]
+docs = [
+    "jupyter-book",
+    "sphinx-book-theme",
+    "sphinx-autodoc-typehints",
+    "sphinxcontrib-autoyaml",
+    "sphinxcontrib.mermaid",
+]
+develop = [
+    "pytest",
+    "pre-commit",
+    "ruff",
+    "isort"
+]
+
+[tool.setuptools.packages.find]
+include = ["floris*"]
+
+[tool.setuptools.package-data]
+floris = [
+    "turbine_library/*.yaml",
+    "core/wake_velocity/turbopark_lookup_table.mat"
+]
+
+[project.urls]
+Homepage = "https://github.com/NREL/floris"
+Documentation = "https://nrel.github.io/floris/"
 
 [coverage.run]
 # Coverage.py configuration file