Feature/expand build matrix

.github/workflows/ci.yml

@@ -0,0 +1,69 @@
+name: CI
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+jobs:
+  test:
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.10", "3.9", "3.8", "3.7"]
+        os: [ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v3
+    - name: "Set up python ${{ matrix.python-version }}"
+      id: setup-python
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    #----------------------------------------------
+    #  -----  install & configure poetry  -----
+    #----------------------------------------------
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
+      with:
+        virtualenvs-create: true
+        virtualenvs-in-project: true
+    #----------------------------------------------
+    #       load cached venv if cache exists
+    #----------------------------------------------
+    - name: Load cached venv
+      id: cached-poetry-dependencies
+      uses: actions/cache@v3
+      with:
+        path: .venv
+        key: venv-${{ matrix.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+    #----------------------------------------------
+    # install dependencies if cache does not exist
+    #----------------------------------------------
+    - name: Install dependencies
+      if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+      run: poetry install --no-interaction --no-root
+    #----------------------------------------------
+    # install your root project, if required
+    #----------------------------------------------
+    - name: Install library
+      run: poetry install --no-interaction
+    #----------------------------------------------
+    #    Run tests
+    #----------------------------------------------
+    - name: Run tests
+      run: poetry run invoke test
+    #----------------------------------------------
+    #    Build docs
+    #----------------------------------------------
+    - name: Build docs
+      run: poetry run invoke docs
+    #----------------------------------------------
+    #    Deploy docs (if on master)
+    #----------------------------------------------
+    - name: Deploy docs 🚀
+      if: github.ref == 'refs/heads/master'
+      uses: JamesIves/github-pages-deploy-action@v4
+      with:
+        folder: docs/_build

cookiecutter.json

@@ -10,8 +10,11 @@
   "use_pytest": "y",
   "use_pypi_deployment_with_travis": "y",
   "add_pyup_badge": "n",
-  "command_line_interface": ["Click", "Argparse", "No command-line interface"],
+  "command_line_interface": ["Click", "No command-line interface"],
   "create_author_file": "y",
   "open_source_license": ["MIT", "BSD-3-Clause", "ISC", "Apache-2.0", "GPL-3.0-only", "Not open source"],
-  "use_google_docstrings": "y"
+  "use_google_docstrings": "y",
+  "_copy_without_render": [
+    "*.github/workflows/*.yml"
+  ]
 }

docs/console_script_setup.rst

@@ -2,7 +2,7 @@
 
 
 Console Script Setup
-=================
+====================
 
 Optionally, your package can include a console script using Click or argparse (Python 3.2+).
 

docs/prompts.rst

@@ -43,9 +43,6 @@ Options
 
 The following package configuration options set up different features for your project.
 
-use_pypi_deployment_with_travis
-    Whether to use PyPI deployment with Travis.
-
 command_line_interface
     Whether to create a console script using Click. Console script entry point will match the project_slug. Options: ['Click', "No command-line interface"]
 

docs/tutorial.rst

@@ -103,7 +103,7 @@ See :ref:`travis-pypi-setup` for more information.
 
 
 Step 6: Set Up Read the Docs
---------------------------
+----------------------------
 
 `Read the Docs`_ hosts documentation for the open source community. Think of it as Continuous Documentation.