moved to pyproject.toml

Author: dwr-psandhu

.github/workflows/main.yml

@@ -13,7 +13,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
         with:
-          fetch-depth: 0
+          fetch-depth: 0  # This is important for setuptools_scm to get the git history
       - name: Set up Python 3.8
         uses: actions/setup-python@v2
         with:
@@ -22,6 +22,17 @@ jobs:
         run: |
           # $CONDA is an environment variable pointing to the root of the miniconda directory
           echo $CONDA/bin >> $GITHUB_PATH
+      - name: Extract tag version for conda build
+        id: get_version
+        run: |
+          # Extract the tag name without 'refs/tags/' prefix
+          GIT_TAG=${GITHUB_REF#refs/tags/}
+          # Set tag as environment variable for conda build
+          echo "GIT_DESCRIBE_TAG=$GIT_TAG" >> $GITHUB_ENV
+          # Also set SETUPTOOLS_SCM_PRETEND_VERSION for consistent versioning
+          echo "SETUPTOOLS_SCM_PRETEND_VERSION=$GIT_TAG" >> $GITHUB_ENV
+          # Print for verification
+          echo "Using version: $GIT_TAG"
       - name: Conda build package and upload to anaconda.org
         env:
           ANACONDA_CHANNEL_UPLOAD_TOKEN: ${{ secrets.ANACONDA_CHANNEL_UPLOAD_TOKEN }}
@@ -30,6 +41,16 @@ jobs:
           source $CONDA/etc/profile.d/conda.sh
           conda activate test_dmsbatch
           conda config --set anaconda_upload yes
+          echo "Building with GIT_DESCRIBE_TAG=$GIT_DESCRIBE_TAG and SETUPTOOLS_SCM_PRETEND_VERSION=$SETUPTOOLS_SCM_PRETEND_VERSION"
           conda build -c defaults -c conda-forge --user cadwr-dms --token "$ANACONDA_CHANNEL_UPLOAD_TOKEN" conda.recipe
           conda activate
           conda remove -n test_dmsbatch --all
+          
+      - name: Build and upload PyPI package
+        if: ${{ false }}  # Disabled by default - enable when ready to publish to PyPI
+        env:
+          PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          python -m pip install --upgrade pip build twine
+          python -m build
+          python -m twine upload --skip-existing dist/* --username __token__ --password "$PYPI_API_TOKEN"

.gitignore

@@ -89,5 +89,19 @@ target/
 # pyenv python configuration file
 .python-version
 
+# setuptools_scm generated version file
+dmsbatch/_version.py
+
+# conda build and pip build artifacts
+conda-bld/
+.eggs/
+pip-wheel-metadata/
+*.conda
+
+# jupyter notebook specific
+.ipython/
+.jupyter/
+.local/
+
 # include all sample ymls:
 !sample_configs/*.yml

MANIFEST.in

@@ -1 +1,4 @@
-include versioneer.py
+include LICENSE
+include README.md
+include dmsbatch/_version.py.template
+recursive-include dmsbatch/templates *

README-pyproject.md

@@ -0,0 +1,54 @@
+# Migration from setup.py to pyproject.toml
+
+This project has been migrated from a classic `setup.py` configuration to a modern `pyproject.toml` configuration. Here are the key changes and how to work with the new setup:
+
+## Package Structure
+
+- `pyproject.toml`: Main configuration file for building, dependencies, and metadata
+- `setup.py`: Minimal file that provides compatibility with older tools
+- Automated versioning using setuptools_scm based on git tags
+
+## Building and Development
+
+For development:
+```bash
+pip install -e .
+```
+
+For building:
+```bash
+pip install build
+python -m build
+```
+
+## Conda Build
+
+The conda recipe has been updated to work with the new pyproject.toml structure. You can build a conda package using:
+
+```bash
+conda build conda.recipe
+```
+
+## Version Management with setuptools_scm
+
+The project now uses setuptools_scm for automatic version determination from git tags:
+
+1. Tag your release: `git tag 2025.05.23`
+2. The version will automatically be determined from the git metadata
+3. Format: `{tag}.post{commits}+{hash}.d{date}` (e.g., `2025.05.23.post2+g7250da5.d20250526`)
+
+## Dependencies
+
+All dependencies are now specified in `pyproject.toml`. Make sure to keep both the pyproject.toml and conda.recipe/meta.yaml files in sync when adding new dependencies.
+
+## CI/CD with GitHub Actions
+
+The GitHub workflow has been updated to work with setuptools_scm:
+
+1. It checks out the complete git history with `fetch-depth: 0` to ensure setuptools_scm has access to all tags
+2. It sets the `SETUPTOOLS_SCM_PRETEND_VERSION` environment variable to ensure consistent versioning
+3. The version is extracted from the git tag and used for both conda and PyPI (when enabled) builds
+
+When a new version is tagged and pushed to GitHub, the workflow will automatically:
+- Build a conda package with the correct version
+- Upload it to the specified Anaconda channel

conda.recipe/meta.yaml

@@ -1,40 +1,32 @@
-{% set data = load_setup_py_data() %}
+{% set name = "dmsbatch" %}
+{% set version = environ.get('GIT_DESCRIBE_TAG', '0.0.0.dev0') %}
 
 package:
-  name: dmsbatch
-  version: {{ data['version'] }}
+  name: {{ name|lower }}
+  version: {{ version }}
 
 source:
   path: ..
 
 build:
-  # If the installation is complex, or different between Unix and Windows, use
-  # 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 .
   noarch: python
-  
   entry_points:
-    {% for entry in data['entry_points']['console_scripts'] %}
-      - {{ entry.split('=')[0].strip() }} = {{ entry.split('=')[1].strip() }}
-    {% endfor %}
-  
+    - dmsbatch = dmsbatch.cli:main
 
 requirements:
-  # if you need compilers, uncomment these
-  #    read more at https://docs.conda.io/projects/conda-build/en/latest/resources/compiler-tools.html
-  # build:
-  #   - {{ compilers('c') }}
   host:
     - python
     - pip
+    - setuptools >=45
+    - wheel
+    - setuptools_scm >=6.2
   run:
     - python
-    # dependencies are defined in setup.py
-    {% for dep in data['install_requires'] %}
-    - {{ dep.lower() }}
-    {% endfor %}
+    - azure-batch >=11.0.0
+    - azure-storage-blob >=2.1.0
+    - azure-mgmt-resource >=18.0.0
+    - azure-identity >=1.5.0
 
 test:
   source_files:
@@ -48,6 +40,6 @@ test:
    - dmsbatch
 about:
   home: https://github.com/CADWRDeltaModeling/azure_dms_batch
-  summary: Azure Batch for Delta Modeling Section 
-  license: {{ data.get('license') }}
+  summary: Azure Batch for Delta Modeling Section
+  license: MIT
   license_file: LICENSE

dmsbatch/__init__.py

@@ -1,9 +1,7 @@
-from ._version import get_versions
-__version__ = get_versions()['version']
-del get_versions
-#
+try:
+    from ._version import __version__
+except ImportError:
+    __version__ = "0.0.0"
+
 from .commands import create_batch_client, create_blob_client, query_yes_no
 from .commands import AzureBatch, AzureBlob
-
-from . import _version
-__version__ = _version.get_versions()['version']