fix docs building

Author: a.pirogov

.github/workflows/ci.yml

@@ -138,8 +138,8 @@ jobs:
 # ----
 
   deploy_demo:
-    needs: docs
-    if: startswith(github.ref, 'refs/tags/v')
+    # needs: docs  # TODO: uncomment when feature works
+    # if: startswith(github.ref, 'refs/tags/v')
     secrets: inherit
     uses: "./.github/workflows/deploy_demo.yml"
 

.github/workflows/deploy_demo.yml

@@ -1,6 +1,4 @@
 name: Deploy the demo repository
-# TODO: could use current version tag of template to match the demo
-# and think how to preserve old branches / docs
 
 on: [workflow_dispatch, workflow_call]
 
@@ -37,9 +35,19 @@ jobs:
     - name: Install cookiecutter
       run: pip install cookiecutter==2.1.1
 
-    - name: Instantiate demo repository
+    - name: Prepare cookiecutter configuration
       run: |
-        cookiecutter ./fair-python-cookiecutter --no-input --config-file=./fair-python-cookiecutter/tests/demo.yaml
+        TEMPLATE_VERSION=$(grep -e "^version" ./fair-python-cookiecutter/pyproject.toml | sed 's/^.*=//')
+        echo "extracted template version:" $TEMPLATE_VERSION
+        SED_CMD_PREF='s/\(^.*version:\).*/\1'
+        SED_CMD="${SED_CMD_PREF}${TEMPLATE_VERSION}/"
+        echo "running sed to insert version:" $SED_CMD
+        sed "$SED_CMD" ./fair-python-cookiecutter/tests/demo.yaml > cconf.yaml
+        echo "resulting repo cookiecutter configuration:"
+        cat cconf.yaml
+
+    - name: Instantiate demo repository
+      run: cookiecutter ./fair-python-cookiecutter --no-input --config-file=cconf.yaml
 
     - name: Deploy generated repository
       run: |

README.md

@@ -85,7 +85,10 @@ This will spawn an interactive prompt, where you have to provide some informatio
 a starting skeleton for your software project. Don't worry, you can always adapt this
 information later on by hand. After this cookiecutter will initate your software project.
 
-The generated repository will include a copy of a [developer guide](./dev_guide.md),
+You can find a demo repository generated from this template
+[here](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter-demo).
+
+Your new project repository will also include a copy of a [developer guide](./dev_guide.md),
 containing more information about the structure and features of the generated project.
 Feel free to either remove it, or keep (and possibly adjust) it as extended technical
 project documentation for yourself and other future project contributors.

codemeta.json

@@ -10,11 +10,11 @@
     "audience": [
         {
             "@type": "Audience",
-            "audienceType": "Developers"
+            "audienceType": "Science/Research"
         },
         {
             "@type": "Audience",
-            "audienceType": "Science/Research"
+            "audienceType": "Developers"
         }
     ],
     "author": [
@@ -54,5 +54,5 @@
             "version": "^3.8"
         }
     ],
-    "version": "0.1.0"
+    "version": "0.1.1"
 }

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "fair-python-cookiecutter"
-version = "0.1.0"
+version = "0.1.1"
 description = "An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata. "
 authors = ["Anton Pirogov <a.pirogov@fz-juelich.de>"]
 license = "MIT"

tests/test_template.py

@@ -71,13 +71,16 @@ def gen_project(**cc_args):
     return gen_project
 
 
+DEMO_PROJ_SLUG = "fair_python_cookiecutter_demo"
+
+
 def test_cookiecutter(gen):
     # generate with default values
     dir = gen()
     sanity_check_project(dir)
     # should NOT have the code files
-    assert not (dir / "src/my_amazing_app/api.py").is_file()
-    assert not (dir / "src/my_amazing_app/cli.py").is_file()
+    assert not (dir / f"src/{DEMO_PROJ_SLUG}api.py").is_file()
+    assert not (dir / f"src/{DEMO_PROJ_SLUG}/cli.py").is_file()
     assert not (dir / "tests/test_api.py").is_file()
     assert not (dir / "tests/test_cli.py").is_file()
     # and the expected license (MIT)
@@ -89,8 +92,8 @@ def test_cookiecutter(gen):
     dir = gen(config_file="./tests/demo.yaml")
     sanity_check_project(dir)
     # should have the code files
-    assert (dir / "src/my_amazing_app/api.py").is_file()
-    assert (dir / "src/my_amazing_app/cli.py").is_file()
+    assert (dir / f"src/{DEMO_PROJ_SLUG}/api.py").is_file()
+    assert (dir / f"src/{DEMO_PROJ_SLUG}/cli.py").is_file()
     assert (dir / "tests/test_api.py").is_file()
     assert (dir / "tests/test_cli.py").is_file()
     # and the expected license (Unlicense)

{{ cookiecutter.__project_slug }}/docs/scripts/coverage_status.py

@@ -20,7 +20,7 @@
 """Colors for overall coverage percentage (0-100)."""
 
 
-def on_pre_build(_config):
+def on_pre_build(config):  # noqa
     """Generate coverage report if it is missing and create a badge."""
     if not Path("htmlcov").is_dir() or not Path(".coverage").is_file():
         log.info("Missing htmlcov or .coverage, running pytest to collect.")