Tutor upgrade pull request

.coveragerc

@@ -0,0 +1,42 @@
+# .coveragerc to control coverage.py
+[run]
+branch = True
+source =
+    ./tutor 
+    ./bin 
+omit =
+    */templates/*
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:
+
+    # Don't complain about abstract methods, they aren't run:
+    @(abc\.)?abstractmethod
+
+ignore_errors = True
+show_missing = True
+skip_empty = True
+precision = 2
+
+[html]
+skip_empty = True
+show_contexts = True
+
+[json]
+pretty_print = True
+show_contexts = True

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,7 +7,7 @@ assignees: ''
 
 ---
 
-<!-- Are you quite sure that you followed the instructions from the Troubleshooting section in the Tutor documentation? https://docs.tutor.overhang.io/troubleshooting.html -->
+<!-- Are you quite sure that you followed the instructions from the Troubleshooting section in the Tutor documentation? https://docs.tutor.edly.io/troubleshooting.html -->
 <!-- If not, please take the time to read them. -->
 
 **Bug description**

.github/ISSUE_TEMPLATE/question.md

@@ -4,6 +4,6 @@ about: This is not the appropriate channel
 
 ---
 
-Please post on our forums: https://discuss.overhang.io for questions about using `tutor`.
+Please post on our forums: https://discuss.openedx.org/tag/tutor for questions about using `tutor`.
 
 Posts that are not a bug report or a feature/enhancement request will not be addressed on this issue tracker.

.github/workflows/auto-add-to-project.yml

@@ -0,0 +1,17 @@
+name: Auto Add Issues to Project
+
+on:
+  issues:
+    types:
+      - opened
+
+jobs:
+  # https://github.com/actions/add-to-project
+  add-to-project:
+    name: Add issue and bugs to project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+        with:
+          project-url: https://github.com/orgs/overhangio/projects/4
+          github-token: ${{ secrets.GH_PROJECT_PERSONAL_ACCESS_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,95 @@
+# This script can be tested locally with act:
+#
+#    act --secret GITHUB_TOKEN=... --job release
+#
+# https://github.com/nektos/act/
+# To generate a token: https://github.com/settings/tokens (add r/w permissions for "Contents")
+name: Release
+
+on:
+  push:
+    tags:
+      - '*'
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          # https://github.com/actions/runner-images#available-images
+          # It's important that we build the tutor binaries with the *oldest* possible
+          # OS releases and Python version. See these docs for more information:
+          # https://pyinstaller.org/en/stable/usage.html#making-gnu-linux-apps-forward-compatible
+          - os: ubuntu-20.04
+            locale: C.UTF-8
+          # https://endoflife.date/macos
+          - os: macos-12
+            locale: en_US.UTF-8
+    env:
+      LC_ALL: ${{ matrix.locale }}
+      LANG: ${{ matrix.locale }}
+    steps:
+      ##### Setup environment
+      # https://github.com/actions/checkout
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        # https://github.com/actions/setup-python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.9
+          cache: 'pip'
+          cache-dependency-path: requirements/dev.txt
+      - name: Upgrade pip and setuptools
+        # https://pypi.org/project/pip/
+        # https://pypi.org/project/setuptools/
+        # https://pypi.org/project/wheel/
+        run: python -m pip install --upgrade pip setuptools==65.6.3 wheel
+      - name: Print info about the current python installation
+        run: make ci-info
+      - name: Install requirements
+        run: make bootstrap-dev-plugins
+
+      ##### Run tests, generate bundle
+      # - name: Run tests
+      #   run: make test
+      - name: Create bundle
+        run: make bundle
+      # - name: Test bundle
+      #   run: make ci-test-bundle
+
+      ##### Download gh utility: https://github.com/cli/cli/releases
+      # This is unnecessary on GitHub, but useful when running locally with act.
+      # WARNING: this will only work on amd64
+      - name: Check or download gh utility
+        run: |
+          if ! which gh; then
+            echo "Downloading 'gh' utility"
+            if [ "$(uname -s)" = "Linux" ]; then
+              curl -L -o gh.tar.gz https://github.com/cli/cli/releases/download/v2.28.0/gh_2.28.0_linux_amd64.tar.gz
+              tar xzf gh.tar.gz
+              mv ./gh_2.28.0_linux_amd64/bin/gh /usr/local/bin/gh
+            else
+              curl -L -o gh.zip https://github.com/cli/cli/releases/download/v2.28.0/gh_2.28.0_macOS_amd64.zip
+              unzip xzf gh.zip
+              mv ./gh_2.28.0_macOS_amd64/bin/gh /usr/local/bin/gh
+            fi
+            which gh
+          fi
+
+      ##### Create release on GitHub
+      - name: Create or update GitHub release
+        run: scriv github-release --repo=overhangio/tutor
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        # scriv command will fail when not on a tag, such as running with act or a
+        # manual trigger.
+        if: ${{ github.ref_type == 'tag' }}
+      - name: Upload release asset to GitHub
+        run: |
+          export FILENAME="tutor-$(uname -s)_$(uname -m)"
+          mv ./dist/tutor $FILENAME
+          gh release upload --clobber v$(make version) $FILENAME
+        env:
+          GH_TOKEN: ${{ github.token }}

.github/workflows/sync.yml

@@ -0,0 +1,17 @@
+name: Sync with private repo
+
+on:
+  push:
+    branches: [ master, main, nightly ]
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Add remote
+        run: git remote add overhangio https://${{ secrets.GIT_USERNAME }}:${{ secrets.GIT_PASSWORD }}@git.overhang.io/core/tutor.git
+      - name: Push
+        run: git push overhangio $GITHUB_REF

.github/workflows/test.yml

@@ -0,0 +1,40 @@
+name: Run tests
+
+on:
+  push:
+    branches: [ master, main, nightly ]
+  pull_request:
+    branches: [ master, main, nightly ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+         python-version: ['3.9', '3.12']
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version:  ${{ matrix.python-version }}
+          cache: 'pip'
+          cache-dependency-path: requirements/dev.txt
+      - name: Upgrade pip
+        run: python -m pip install --upgrade pip setuptools
+      - name: Install dependencies
+        run: pip install -r requirements/dev.txt
+      - name: Static code analysis
+        run: make test-lint
+      - name: Python unit tests
+        run: make test-unit
+      - name: Static type checks
+        run: make test-types
+      - name: Code formatting
+        run: make test-format
+      - name: Package tests
+        run: make test-pythonpackage
+      - name: Install docs dependencies
+        run: pip install -r requirements/docs.txt
+      - name: Build docs
+        run: make docs

.gitignore

@@ -6,4 +6,7 @@ __pycache__
 
 /build/
 /dist/
-/releases/
+
+# Unit test/ coverage reports
+.coverage
+/htmlcov/