convert to pyproject.toml from setup.py

Author: lily-tomkovic-DWR

.github/workflows/python-package-conda.yml

@@ -24,10 +24,10 @@ jobs:
       env: 
         ANACONDA_CHANNEL_UPLOAD_TOKEN: ${{ secrets.ANACONDA_CHANNEL_UPLOAD_TOKEN }}
       run: |
-        conda create -n test_vtools3 -y conda-build conda-verify numpy anaconda-client
+        conda create -n test_vtools3 -y conda-build conda-verify numpy anaconda-client setuptools-scm
         source $CONDA/etc/profile.d/conda.sh
         conda activate test_vtools3
         conda config --set anaconda_upload yes
-        conda build --user cadwr-dms --token "$ANACONDA_CHANNEL_UPLOAD_TOKEN" conda.recipe
+        conda build -c cadwr-dms -c conda-forge --user cadwr-dms --token "$ANACONDA_CHANNEL_UPLOAD_TOKEN" conda.recipe
         conda activate
         conda remove -n test_vtools3 --all

conda.recipe/meta.yaml

@@ -1,10 +1,11 @@
-{% set name = "vtools3" %}
-{% set data = load_setup_py_data() %}
+{# raw is for ignoring templating with cookiecutter, leaving it for use with conda-build -#}
+{% set pyproject = load_file_data('../pyproject.toml', from_recipe_dir=True) %}
+{% set project = pyproject['project'] %}
+{% set version = load_setup_py_data().get('version', '0.0.0') %}
 
 package:
-  name: "{{ name|lower }}"
-  
-  version: {{ data['version'] }}
+  name: vtools
+  version: {{ version }}
 
 source:
   path: ..
@@ -14,37 +15,49 @@ build:
   # separate bld.bat and build.sh files instead of this key.  Add the line
   # "skip: True  # [py<35]" (for example) to limit to Python 3.5 and newer, or
   # "skip: True  # [not win]" to limit to Windows.
-  script: {{ PYTHON }} -m pip install --no-deps --ignore-installed -vv .
+  script: {{ PYTHON }} -m pip install --no-build-isolation --no-deps --ignore-installed -vv .
   noarch: python
+  number: 0
   entry_points:
-  {% for entry in data['entry_points']['console_scripts'] %}
-    - {{ entry.split('=')[0].strip() }} = {{ entry.split('=')[1].strip() }}
-  {% endfor %}
-
+    {% for name, reference in project['scripts'].items() %}
+    - {{ name }} = {{ reference }}
+    {% endfor %}
 
 requirements:
+  host:
+    - python {{ project['requires-python'] }}
+    - pip
+    - numpy >=1.23
+    {% for dep in pyproject['build-system']['requires'] %}
+    - {{ dep.lower() }}
+    {% endfor %}
   build:
     - python
     - setuptools
     - pandas >=0.23
+    - numpy >=1.23
   run:
     - python
     - numpy  >=1.11
     - pandas >=0.23
     - scipy >=1.2
     - beautifulsoup4 >=4.8
     - xlrd
-  test:
-    imports:
-      - vtools
-    source_files:
-      - tests
-    requires:
-      - pytest
-      - pytest-cov
-    commands:
-      - (setlocal && cd tests && pytest && endlocal) # [win]
-      - (cd tests; pytest) # [unix]
+    {% for dep in project.get('dependencies', []) %}
+    - {{ dep.lower() }}
+    {% endfor %}  
+test:
+  imports:
+    - vtools
+  source_files:
+    - tests
+  requires:
+    {% for dep in project.get("optional-dependencies", {}).get('test', []) %}
+    - {{ dep.lower() }}
+    {% endfor %}
+  commands:
+    - (setlocal && cd tests && pytest && endlocal) # [win]
+    - (cd tests; pytest) # [unix]
 
 about:
   home: https://github.com/CADWRDeltaModeling/vtools3

pyproject.toml

@@ -0,0 +1,66 @@
+[build-system]
+requires = ["setuptools>=61", "wheel", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "vtools3"
+dynamic = ["version"] # Placeholder; versioneer will manage this
+description = "Timeseries analysis and processing tools using pandas/xarray"
+readme = "README.md"
+license = { file = "LICENSE" }
+authors = [
+    { name = "California Department of Water Resources", email = "Eli.Ateljevich@water.ca.gov"}
+]
+requires-python = ">=3.6"
+classifiers = [
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9"
+]
+keywords = ["vtools"]
+dependencies = [
+    "numpy",
+    "pandas",
+    "xarray",
+    "dask",
+    "matplotlib",
+    "scikit-learn",
+    "scipy",
+    "statsmodels>=0.13"
+]
+
+[project.optional-dependencies]
+doc = [
+    "sphinx",
+    "sphinx-rtd-theme",
+    "myst-parser",
+    "numpydoc"
+]
+test = [
+    "pytest>=3",
+    "pytest-cov",
+    "tox",
+    "click"
+]
+[project.urls]
+Homepage = "https://github.com/CADWRDeltaModeling/vtools3"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.flake8]
+exclude = ["docs"]
+
+[tool.pytest.ini_options]
+collect_ignore = ["setup.py"]
+
+[tool.setuptools.packages.find]
+include = ["vtools"]
+exclude = ["docsrc"]
+
+[tool.setuptools_scm]
+version_scheme = "post-release"
+local_scheme = "dirty-tag"
+
+[project.scripts]

setup.cfg

@@ -1,46 +1,9 @@
-from setuptools import setup, find_packages
+from setuptools import setup
 
-##------------------ VERSIONING BEST PRACTICES --------------------------##
-import versioneer
-
-with open('README.md') as readme_file:
-    readme = readme_file.read()
-
-
-requirements = ["numpy", 
-                "pandas", 
-                "xarray", 
-                "dask",
-                "matplotlib", 
-                "scikit-learn", 
-                "scipy",
-                "statsmodels>=0.13"]
-
-
-
-extras = {"tests":"pytest",
-          "docs": ["nbsphinx","sphinx-argparse","numpydoc"]}
+# setup.py only needed for conda to resolve versioning
+# DO NOT ADD ANYTHING ELSE HERE
 
 setup(
-    name='vtools3',
-    version=versioneer.get_version(),
-    cmdclass=versioneer.get_cmdclass(),
-    description="Timeseries analysis and processing tools using pandas/xarray",
-    license="Apache",
-    long_description=readme,
-    install_requires=requirements,
-    extras_require=extras,
-    include_package_data=True,
-    keywords='vtools',
-    packages=find_packages(),
-    author="Eli Ateljevich",
-    author_email='eli@water.ca.gov',
-    url='https://github.com/CADWRDeltaModeling/vtools3',
-    classifiers=[
-        'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8',
-        'Programming Language :: Python :: 3.9',
-    ],
-    entry_points = { 'console_scripts' : [] }
+    name="vtools",
+    use_scm_version=True,
 )