Move project metadata to pyproject.toml; avoid calling setup.py (pyvi…

…sta#3619)
Onandon11 · Nov 21, 2022 · 80185ea · 80185ea
1 parent 887323c
commit 80185ea
Show file tree

Hide file tree

Showing 5 changed files with 102 additions and 108 deletions.
diff --git a/.github/workflows/docker-package.yml b/.github/workflows/docker-package.yml
@@ -40,7 +40,8 @@ jobs:
 
       - name: Create PyVista package
         run: |
-          python setup.py sdist
+          pip install build
+          python -m build --sdist
 
       - name: Log into the Container registry
         uses: docker/login-action@v2

diff --git a/.github/workflows/testing-and-deployment.yml b/.github/workflows/testing-and-deployment.yml
@@ -39,7 +39,6 @@ jobs:
 
       - name: Install PyVista
         run: |
-          pip install wheel
           pip install .
           python -c "import pyvista;print(pyvista.Report(gpu=False));from pyvista import examples;print('User data path:', examples.USER_DATA_PATH)"
 
@@ -163,8 +162,8 @@ jobs:
 
       - name: Build wheel and install pyvista
         run: |
-          pip install wheel
-          python setup.py bdist_wheel
+          pip install build
+          python -m build --wheel
           pip install dist/pyvista*.whl
 
       - name: Set up vtk
@@ -194,9 +193,9 @@ jobs:
 
       - name: Check package
         run: |
-          pip install twine
-          python setup.py sdist
-          twine check dist/*
+          pip install build twine
+          python -m build
+          twine check --strict dist/*
 
       - name: Upload to PyPi
         if: matrix.python-version == '3.9' && startsWith(github.ref, 'refs/tags/v')
@@ -231,7 +230,6 @@ jobs:
 
       - name: Install PyVista
         run: |
-          pip install wheel
           pip install .
           python -c "import pyvista; print(pyvista.Report(gpu=False)); from pyvista import examples; print('User data path:', examples.USER_DATA_PATH)"
 

diff --git a/docker/README.md b/docker/README.md
@@ -20,6 +20,7 @@ PyVista in Jupyter Lab!
 Clone PyVista and run the following at the top level of the project:
 
 ```bash
-python setup.py sdist
+pip install build
+python -m build --sdist
 docker build -t my-pyvista-jupyterlab -f docker/jupyter.Dockerfile
 ```
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,3 +1,94 @@
+[build-system]
+requires = ['setuptools']
+build-backend = 'setuptools.build_meta'
+
+[project]
+name = 'pyvista'
+description = 'Easier Pythonic interface to VTK'
+authors = [
+    {name = 'PyVista Developers', email = '[email protected]'},
+]
+readme = 'README.rst'
+requires-python = '>=3.7'
+keywords = ['vtk', 'numpy', 'plotting', 'mesh']
+license = {text = 'MIT'}
+classifiers = [
+    'Development Status :: 4 - Beta',
+    'Intended Audience :: Science/Research',
+    'Topic :: Scientific/Engineering :: Information Analysis',
+    'License :: OSI Approved :: MIT License',
+    'Operating System :: Microsoft :: Windows',
+    'Operating System :: POSIX',
+    'Operating System :: MacOS',
+    'Programming Language :: Python :: 3.7',
+    'Programming Language :: Python :: 3.8',
+    'Programming Language :: Python :: 3.9',
+    'Programming Language :: Python :: 3.10',
+]
+dependencies = [
+    'imageio',
+    'numpy',
+    'pillow',
+    'pooch',
+    'scooby>=0.5.1',
+    "typing-extensions; python_version < '3.8'",
+    'vtk',
+]
+dynamic = ['version']
+
+[project.optional-dependencies]
+all = [
+    'cmocean',
+    'colorcet',
+    'ipyvtklink',
+    'matplotlib',
+    'meshio>=5.2',
+    'panel',
+    'pythreejs',
+]
+colormaps = [
+    'cmocean',
+    'colorcet',
+    'matplotlib',
+]
+io = ['meshio>=5.2']
+jupyter = [
+    'ipyvtklink',
+    'panel',
+    'pythreejs',
+]
+
+[project.urls]
+Documentation = 'https://docs.pyvista.org/'
+"Bug Tracker" = 'https://github.com/pyvista/pyvista/issues'
+"Source Code" = 'https://github.com/pyvista/pyvista'
+
+[tool.setuptools.dynamic]
+version = {attr = 'pyvista._version.__version__'}
+
+[tool.setuptools.packages.find]
+include = [
+    'pyvista',
+    'pyvista.*',
+]
+
+[tool.setuptools.package-data]
+pyvista = [
+    'py.typed',
+]
+"pyvista.examples" = [
+    '2k_earth_daymap.jpg',
+    'airplane.ply',
+    'ant.ply',
+    'channels.vti',
+    'globe.vtk',
+    'hexbeam.vtk',
+    'nut.ply',
+    'rectilinear.vtk',
+    'sphere.ply',
+    'uniform.vtk',
+]
+
 [tool.isort]
 profile = 'black'
 line_length = 100

diff --git a/setup.py b/setup.py
@@ -1,101 +1,4 @@
-"""Installation file for python pyvista module."""
-from io import open as io_open
-import os
-
+"""See pyproject.toml for project metadata."""
 from setuptools import setup
 
-package_name = 'pyvista'
-
-__version__ = None
-filepath = os.path.dirname(__file__)
-version_file = os.path.join(filepath, package_name, '_version.py')
-with io_open(version_file, mode='r') as fd:
-    exec(fd.read())
-
-install_requires = [
-    'numpy',
-    'imageio',
-    'pillow',
-    'pooch',
-    'scooby>=0.5.1',
-    'vtk',
-    "typing-extensions; python_version < '3.8'",
-]
-
-readme_file = os.path.join(filepath, 'README.rst')
-
-setup(
-    name=package_name,
-    packages=[
-        'pyvista',
-        'pyvista.examples',
-        'pyvista.core',
-        'pyvista.core.filters',
-        'pyvista.demos',
-        'pyvista.jupyter',
-        'pyvista.plotting',
-        'pyvista.utilities',
-        'pyvista.ext',
-    ],
-    version=__version__,
-    description='Easier Pythonic interface to VTK',
-    long_description=io_open(readme_file, encoding="utf-8").read(),
-    long_description_content_type='text/x-rst',
-    author='PyVista Developers',
-    author_email='[email protected]',
-    license='MIT',
-    classifiers=[
-        'Development Status :: 4 - Beta',
-        'Intended Audience :: Science/Research',
-        'Topic :: Scientific/Engineering :: Information Analysis',
-        'License :: OSI Approved :: MIT License',
-        'Operating System :: Microsoft :: Windows',
-        'Operating System :: POSIX',
-        'Operating System :: MacOS',
-        'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8',
-        'Programming Language :: Python :: 3.9',
-        'Programming Language :: Python :: 3.10',
-    ],
-    url='https://github.com/pyvista/pyvista',
-    keywords='vtk numpy plotting mesh',
-    package_data={
-        'pyvista': [
-            'py.typed',
-        ],
-        'pyvista.examples': [
-            'airplane.ply',
-            'ant.ply',
-            'channels.vti',
-            'hexbeam.vtk',
-            'sphere.ply',
-            'nut.ply',
-            'uniform.vtk',
-            'rectilinear.vtk',
-            'globe.vtk',
-            '2k_earth_daymap.jpg',
-        ],
-    },
-    project_urls={
-        "Documentation": "https://docs.pyvista.org/",
-        "Bug Tracker": "https://github.com/pyvista/pyvista/issues",
-        "Source Code": "https://github.com/pyvista/pyvista",
-    },
-    python_requires='>=3.7.*',
-    install_requires=install_requires,
-    extras_require={
-        'all': [
-            'matplotlib',
-            'colorcet',
-            'cmocean',
-            'meshio>=5.2',
-            'ipyvtklink',
-            'panel',
-            'pythreejs',
-        ],
-        'colormaps': ['matplotlib', 'colorcet', 'cmocean'],
-        'io': ['meshio>=5.2'],
-        'jupyter': ['ipyvtklink', 'panel', 'pythreejs'],
-    },
-    zip_safe=False,
-)
+setup()