Merge pull request #4 from quant-aq/dmcc/project-config-updates

Fix setup issues discovered with aeromancy-demo-housing

Author: dmcc

copier.yml

@@ -93,4 +93,4 @@ python_package_import_name:
 python_package_requires_python:
   type: str
   help: The python version range your project supports
-  default: ">=3.11"
+  default: ">=3.10"

project/.github/workflows/ci.yml

@@ -7,7 +7,6 @@ on:
       - "**.md"
   push:
     branches:
-      - master
       - main
     paths-ignore:
       - "docs/**"
@@ -21,23 +20,18 @@ jobs:
         python-version: ['3.10']
         os: [ubuntu-latest]
 
-        steps:
-          - name: Checkout branch
-            uses: actions/checkout@v3
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v3
 
-          - name: Set up PDM
-            uses: pdm-project/setup-pdm@main
-            with:
-              python-version: ${{ matrix.python-version }}
-              cache: true
+      - name: Set up PDM
+        uses: pdm-project/setup-pdm@main
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: true
 
-          - name: Setup ssh key
-            uses: webfactory/ssh-agent@v0.5.1
-            with:
-              ssh-private-key: ${{ secrets.SSH_KEY }}
+      - name: Install dependencies
+        run: pdm install
 
-          - name: Install dependencies
-            run: pdm install
-
-          - name: Run Tests
-            run: pdm test
+      - name: Run Tests
+        run: pdm test

project/pyproject.toml.jinja

@@ -13,7 +13,7 @@ readme = "README.md"
 requires-python = "{{ python_package_requires_python }}"
 dependencies = [
     # keep-sorted start
-    "aeromancy @ git+ssh://git@github.com/quant-aq/aeromancy.git",
+    "aeromancy @ git+https://github.com/quant-aq/aeromancy@v0.3.0",
 ] # keep-sorted end
 dynamic = ["version"]
 
@@ -65,6 +65,10 @@ doc.shell = "cd docs && mkdocs serve -a localhost:8010"
 lint.help = "Run linters over all files"
 lint.cmd = "pre-commit run --all-files"
 
+# PDM hook to automatically sort dependencies when they change.
+# "true" is there since GitHub Actions will fail if this returns a non-zero exit code.
+post_install.shell = "pre-commit run keep-sorted --files pyproject.toml > /dev/null 2> /dev/null; true"
+
 #
 # Standard Aeromancy scripts.
 #
@@ -87,11 +91,7 @@ help.help = "Show the combined help menu (Aeromancy runtime + job selection + pr
 help.cmd = "python src/main.py --help"
 
 aeroset.help = "Use a specific reference/tag/version of Aeromancy"
-aeroset.shell = """pdm remove aeromancy ;
-  pdm add 'git+ssh://git@github.com/quant-aq/aeromancy.git@{args}' &&
-  pdm install &&
-  pre-commit run keep-sorted --files pyproject.toml > /dev/null
-"""
+aeroset.shell = "pdm add 'git+https://github.com/quant-aq/aeromancy@{args}' && pdm install"
 
 [tool.black]
 line-length = 88