Merge pull request #38 from lincc-frameworks/issue/17/basic-automated-template-testing

Issue/17/basic automated template testing

Author: drewoldag

.github/workflows/ci.yml

@@ -0,0 +1,59 @@
+name: CI for Template
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  tests:
+    name: ${{ matrix.name }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        include:
+
+          - name: Base example
+            extra_flags: ''
+            foldername: 'base_example'
+
+          - name: Provide non-default answers
+            extra_flags: '--data project_name=new_science --data module_name=drewtonian --data author_name=Drew --data author_email=ao@aol.com'
+            foldername: 'non_default_answers'
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.10'
+    - name: Install Python dependencies
+      run: |
+        sudo apt-get update
+        python -m pip install --upgrade pip
+        python -m pip install copier
+    - name: Generate package
+      run: |
+        copier --vcs-ref HEAD --defaults ${{ matrix.extra_flags }} copy ./ ../test/${{ matrix.foldername }}
+        cd ../test/${{ matrix.foldername }}
+        cat .copier-answers.yml
+    - name: Build package
+      run: |
+        cd ../test/${{ matrix.foldername }}
+        pip install -e .
+        pip install .[dev]
+    - name: Code style checks
+      run: |
+        cd ../test/${{ matrix.foldername }}
+        python -m pylint --recursive=y ./src/
+    - name: Build docs
+      run: |
+        cd ../test/${{ matrix.foldername }}
+        sphinx-build -b html docs/source docs/build/html
+    - name: Tests
+      run: |
+        cd ../test/${{ matrix.foldername }}
+        python -m pytest tests/*

copier.yml

@@ -1,6 +1,7 @@
 project_name:
     type: str
     help: What is the name of your project?
+    default: example_project
 
 module_name:
     type: str
@@ -11,10 +12,12 @@ author_name:
     type: str
     help: Your first and last name?
     placeholder: Jenny Fantastic
+    default: Name Placeholder
 
 author_email:
     type: str
     help: Your preferred email address?
+    default: email.placeholder@someplace.special
 
 ###
 # Below this line are Copier configuration options.

python-project-template/docs/requirements.txt

@@ -1,2 +1,2 @@
-sphinx==6.1.3
+sphinx==5.3.0
 sphinx_rtd_theme==1.1.1

python-project-template/pyproject.toml.jinja

@@ -27,7 +27,7 @@ dev = [
     "pre-commit", # Used to run checks before finalizing a git commit
     "nbconvert", # Needed for pre-commit check to clear output from Python notebooks
     "pylint", # Used for static linting of files
-    "sphinx==6.1.3", # Used to automatically generate documentation
+    "sphinx==5.3.0", # Used to automatically generate documentation
     "sphinx_rtd_theme==1.1.1", # Used to render documentation
 ]