rename and release the project

.github/workflows/release.yml

@@ -0,0 +1,34 @@
+name: release the package to pypi
+on:
+  release:
+    types:
+      - created
+jobs:
+  release:
+    name: draft release when tagged
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - name: fetch contents
+        uses: actions/checkout@v3
+      - uses: actions/download-artifact@v3
+        with:
+          name: dist
+          path: dist
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - name: install twine and pytest
+        run: |
+          pip install twine pytest
+      - name: Publish package distributions to TestPyPI
+        run: |
+          twine upload --user __token__ --password ${{secrets.HATCH_PYPI_AUTH}} dist/*
+      - name: install nbconvert-a11y dependencies from test pip
+        run: |
+          pip install nbconvert-a11y
+      - name: test test release
+        run: |
+          pytest tests/test_smoke.py

.github/workflows/test.yml

@@ -45,7 +45,7 @@ jobs:
         uses: actions/cache@v2
         env:
           # Increase this value to reset cache if etc/example-environment.yml has not changed
-          CACHE_NUMBER: 0
+          CACHE_NUMBER: 1
         with:
           path: ~/conda_pkgs_dir
           key: ${{ runner.os }}-conda-${{ env.CACHE_NUMBER }}-${{
@@ -54,12 +54,16 @@ jobs:
         with:
           environment-file: test-environment.yml
           cache-environment: true
-      - name: init playwright nbconvert-a11y
+      - name: init plawright
         run: |
           playwright install --with-deps chromium
+      - name: init node & files
+        run: |
           npm install vnu-jar axe-core
-          pip install -e.
           doit copy
+      - name: init dev module
+        run: |
+          pip install -e.
       - name: smoke test
         run: |
           # the smoke generate html assets that are used in the accessibility testing.
@@ -70,10 +74,33 @@ jobs:
         # always build the docs to see what the new versions look like.
         continue-on-error: true
         run: |
-          pytest --deselect tests/test_smoke.py
+          pytest --deselect tests/test_smoke.py  \
+          -n auto --self-contained-html --html=tests/exports/pytest/report.html
+      - name: build wheel and sdist
+        run: |
+          python -m build
+      - uses: actions/upload-artifact@v3
+        with:
+          name: dist
+          path: dist
       - name: mkdocs
         run: |
           mkdocs build -v
+      - uses: actions/upload-artifact@v3
+        with:
+          name: site
+          path: site
+  publish:
+    name: publish the mkdocs build to github pages
+    needs: [test]
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout repo
+        uses: actions/checkout@v3
+      - uses: actions/download-artifact@v3
+        with:
+          name: site
+          path: site
       - name: Deploy main 🚀
         uses: JamesIves/github-pages-deploy-action@v4
         if: ${{ github.ref_name == 'main' }}
@@ -87,3 +114,44 @@ jobs:
           folder: site # The folder the action should deploy.
           single-commit: true
           target-folder: branch/${{ github.ref_name }}
+  release:
+    name: draft release when tagged
+    if: startsWith(github.ref, 'refs/tags/')
+    needs: [test]
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - name: fetch contents
+        uses: actions/checkout@v3
+      - uses: actions/download-artifact@v3
+        with:
+          name: dist
+          path: dist
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+          cache: pip
+          cache-dependency-path: pyproject.toml
+      - name: install twine and pytest
+        run: |
+          pip install twine pytest
+      - name: Publish package distributions to TestPyPI
+        run: |
+          twine upload --repository testpypi \
+          --user __token__ --password ${{secrets.HATCH_TEST_INDEX_AUTH}} \
+          dist/*
+      - name: install nbconvert-a11y dependencies from test pip
+        run: |
+          pip install \
+          --index-url 'https://test.pypi.org/simple/' \
+          --extra-index-url 'https://pypi.org/simple/' \
+          nbconvert-a11y
+      - name: test test release
+        run: |
+          pytest tests/test_smoke.py
+      - uses: ncipollo/release-action@v1
+        with:
+          artifacts: "dist/.*"
+          draft: true # does not trigger a created event

pyproject.toml

@@ -11,8 +11,8 @@ requires = ["hatch-vcs", "hatchling"]
 name = "nbconvert-a11y"
 description = "nbconvert templates using modern standards"
 readme = "README.md"
-url = "https://github.com/Iota-School/notebooks-for-all"
-requires-python = ">=3.7"
+url = "https://github.com/deathbeds/nbconvert-a11y"
+requires-python = ">=3.8"
 license = "BSD-3-Clause"
 keywords = []
 authors = [{ name = "tonyfast", email = "tony.fast@gmail.com" }]
@@ -22,7 +22,6 @@ classifiers = [
   "Natural Language :: English",
   "Programming Language :: Python",
   "Programming Language :: Python :: 3 :: Only",
-  "Programming Language :: Python :: 3.7",
   "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
@@ -32,10 +31,10 @@ classifiers = [
 dependencies = [
   "accessible-pygments",
   "html5lib",
-  "IPython",
   "markdown-it-py[linkify,plugins]",
   "nbconvert",
   "python-slugify",
+  "exceptiongroup; python_version < '3.12'"
 ]
 dynamic = ["version"]
 
@@ -93,7 +92,7 @@ run = "pytest"
 
 [tool.pytest.ini_options]
 minversion = "6.0"
-addopts = "-vvv -pno:importnb -n auto --self-contained-html --html=tests/exports/pytest/report.html"
+addopts = "-vvv -pno:importnb"
 testpaths = ["tests", "test_playwright.py"]
 norecursedirs = ["tests/exports", "tests/notebooks", "*checkpoints"]
 

test-environment.yml

@@ -14,6 +14,7 @@ dependencies:
     - markdown-it-py[plugins,linkify]
     - python-slugify
     - html5lib
+    - build
   - nodejs
   - playwright
   - nbconvert

tests/test_smoke.py

@@ -16,8 +16,8 @@
 from pytest import mark, param
 
 import nbconvert_a11y
+import jupyter_core.paths
 
-TEMPLATES = Path(nbconvert_a11y.__file__).parent / "templates/a11y"
 SKIP_BASELINE = "baseline tests skipped locally"
 LOGGER = getLogger(__name__)
 HERE = Path(__file__).parent
@@ -64,7 +64,7 @@ def get_target_html(config, notebook):
 )
 
 
-assets = mark.parametrize("assets", [TEMPLATES / "settings.js", TEMPLATES / "style.css"])
+assets = mark.parametrize("asset", ["settings.js", "style.css"])
 
 
 @configs
@@ -74,14 +74,15 @@ def test_config_loading(config):
 
 
 @assets
-def test_static_assets(assets):
+def test_static_assets(asset):
     """This is a bad test. it won't fail, but needs to run to collect testing assets."""
-    target = HTML / assets.name
-    try:
-        assert target.exists(), f"{assets.name} doesn't exist."
-    except AssertionError:
-        copyfile(assets, target)
-        assert target.exists(), f"{assets.name} couldn't be created"
+    target = HTML / asset
+    target.parent.mkdir(exist_ok=True, parents=True)
+    for path in map(Path, jupyter_core.paths.jupyter_path("nbconvert", "templates", "a11y", asset)):
+        if path.exists():
+            copyfile(path, target)
+            break
+    assert target.exists(), f"{asset} couldn't be created"
 
 
 @configs