Merge pull request #23 from NCAS-CMS/basic_package

Basic python package with conda-forge environment file

Author: bnlawrence

.github/workflows/build-and-deploy-on-pypi.yml

@@ -0,0 +1,52 @@
+name: PyPi Build and Deploy 🐍📦
+
+on:
+  release:
+    types: [published]
+  # use this for testing
+  push:
+    branches:
+      - main
+      - basic_package
+
+jobs:
+  build-n-publish:
+    name: Build and publish xconv2 on PyPi
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/xconv2/
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - name: Set up Python 3.14
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.14"
+      - name: Install pep517
+        run: >-
+          python -m
+          pip install
+          pep517
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: >-
+          python -m
+          pep517.build
+          --source
+          --binary
+          --out-dir dist/
+          .
+      ### test for Test PyPI
+      # - name: Publish distribution to Test PyPI
+      #   uses: pypa/gh-action-pypi-publish@release/v1
+      #   with:
+      #     repository-url: https://test.pypi.org/legacy/
+      ###
+      - name: Publish distribution 📦 to PyPI
+        if: startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/pytest.yml

@@ -0,0 +1,55 @@
+name: xconv2 Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  schedule:
+    - cron: '0 0 * * *'  # nightly
+
+# Required shell entrypoint to have properly configured bash shell
+defaults:
+  run:
+    shell: bash -l {0}
+
+jobs:
+  build:
+
+    name: Test Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          activate-environment: xconv2
+          environment-file: environment.yml
+          python-version: ${{ matrix.python-version }}
+          miniforge-version: "latest"
+          use-mamba: true
+      - name: Install xconv2
+        run: pip install -e .
+      - name: Run pip check
+        run: pip check
+      # - name: Run pre-commit with mypy
+      #   run: |
+      #     pre-commit install
+      #     pre-commit run -a
+      - name: Check environment contents
+        run: |
+          conda list
+          pip list
+      - name: Test xconv2
+        run: |
+          which xconv2
+      - name: Test with pytest
+        run: pytest

environment.yml

@@ -0,0 +1,18 @@
+---
+name: xconv2
+channels:
+  - conda-forge
+  - nodefaults
+
+dependencies:
+  - python >=3.12
+  - pip !=21.3
+  - cf-plot
+  - cf-python
+  - pandas
+  - pyside6
+  - setuptools >80  # cfplot imports distutils
+  - superqt
+  - zarr
+  # testing
+  - pytest

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=61.0"]
+requires = ["setuptools>=80"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -13,6 +13,8 @@ dependencies = [
     "cf-python",
     "cf-plot",
     "zarr",
+    "pandas",
+    "setuptools>80",
 ]
 
 [project.optional-dependencies]