Use our own rendering exclusively (#277)

I ended up changing more than I planned to.

Author: konstin

.github/workflows/publish.yaml

@@ -8,81 +8,50 @@ env:
 
 on:
   pull_request:
-    types: [ opened, reopened, synchronize ]
   push:
     branches:
       - main
+  workflow_dispatch:
 
 jobs:
   publish-packages:
-    name: Publish python packages
+    name: Publish package index
     runs-on: ubuntu-latest
     timeout-minutes: 10
 
     permissions:
       contents: write # Needed for GH pages updates
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Set up uv
-        run: |
-          curl -LsSf https://astral.sh/uv/install.sh | sh
+        uses: astral-sh/setup-uv@v6
 
       - name: Set up Python ${{ env.PYTHON_VERSION }}
         uses: actions/setup-python@v5
         with:
           python-version: "${{ env.PYTHON_VERSION }}"
 
-      - name: Install zsh
-        run: |
-          sudo apt-get update
-          sudo apt-get install zsh
-
       - name: Install packages
         run: |
           uv sync --extra index
 
-      - name: Collect scenarios
-        run: |
-          scenarios=(scenarios/**/*.(json|yaml|toml))
-
-          # Display for debug
-          for scenario in $scenarios
-          do
-            echo "$scenario"
-          done
-          echo "SCENARIOS=$scenarios" >> "$GITHUB_ENV"
-
-          # Assigning a glob to a variable in `bash` is such a pain I don't want to talk about it
-          # instead we just use zsh
-        shell: zsh {0}
-
       - name: View scenarios
         run: |
-          uv run -- packse view $SCENARIOS
+          uv run -- packse view scenarios/**/*.{toml,yaml,json}
 
-      - name: Build scenarios
+      - name: Build scenarios and index
         run: |
-          uv run -- packse build --skip-root --no-hash $SCENARIOS
-
-      - name: Publish scenarios [local]
-        if: github.ref != 'refs/heads/main'
-        run: |
-          # Start the local index server, do not allow packages from PyPI
-          index_url=$(uv run -- packse index up --bg --offline --dist-dir "./published")
-
-          # Publish the packages
-          uv run -- packse publish --anonymous --index-url "$index_url" dist/*
+          uv run -- packse index build --no-hash scenarios
 
-          # Shutdown the index server
-          uv run -- packse index down
+      - name: Publish scenarios
+        run: echo ${{ github.ref }}
 
-      - name: Publish scenarios [gh pages]
+      - name: Publish scenarios
         if: github.ref == 'refs/heads/main'
         run: |
           commit=$(./scripts/version parts | jq -r ".short_hash")
-          uv run -- packse index build --no-hash --dist-dir ./dist $SCENARIOS
 
           git fetch origin gh-pages
           git branch gh-pages FETCH_HEAD

.gitignore

@@ -1,7 +1,8 @@
-__pycache__
-.cache
 *.pyc
+.cache
 .envrc
+__pycache__
 build/**/*
 dist/**/*
-node_modules
+index/**/*
+node_modules

README.md

@@ -102,7 +102,7 @@ Notice, when a specific scenario is specified, there is more information display
 A scenario can be used to generate packages and build distributions:
 
 ```bash
-packse build scenario/example.json
+packse build scenario/example.toml
 ```
 
 The `build/` directory will contain sources for all of the packages in the scenario.
@@ -116,71 +116,49 @@ publishing multiple times to a registry that does not allow overwrites.
 The `PACKSE_VERSION_SEED` environment variable can be used to override the seed used to generate the unique
 identifier, allowing versions to differ based on information outside of packse.
 
-### Publishing scenarios
-
-Built scenarios can be published to a Python Package Index with the `publish` command:
-
-```bash
-packse publish dist/example-cd797223
-```
-
-By default, packages are published to the Test PyPI server.
-
-Credentials must be provided via the `PACKSE_PYPI_PASSWORD` environment variable. `PACKSE_PYPI_USERNAME` can be
-used to set a username if not using an API token. If using a server which does not require authentication, the
-`--anonymous` flag can be passed.
-
 ### Running a package index
 
-_Requires installation with the `index` extra_
+_Requires installation with the `serve` extra_
 
-A local package index can be controlled with the `index` command. For example, to start a local package index:
+To start a local package index:
 
 ```bash
-packse index up
+packse serve
 ```
 
-The `--bg` flag can be passed to run the index in the background.
-When running an index in the background, state will be stored in the `~/.packse` directory. The `PACKSE_STATE_PATH`
-environment variable can be used to change the state path.
-
 Packages can be installed by passing the `--index-url` flag to the installer e.g. with `pip`:
 
 ```bash
-pip install --index-url http://127.0.0.1:3141 example-0611cb74
+pip install --index-url http://127.0.0.1:3141/simple-html example-a-e656679f
 ```
 
-Packages can be published to the index by providing the `--index-url` and `--anonymous` flags to the `publish` command:
+To also include build dependencies, use the `/vendor` subdirectory:
 
 ```bash
-packse publish dist/example-cd797223 --index-url http://localhost:3141 --anonymous
+pip install --index-url http://127.0.0.1:3141/simple-html --find-links http://127.0.0.1:3141/vendor example-a-e656679f
 ```
 
-Packages can also be published to the index by placing their distributions in the configured `--dist-dir`. This defaults
-to `./dist` which is also the default location used in `packse build`.
-
-By default, the index will fallback to PyPI for missing packages. To test in isolation, use the `--offline` flag.
-
-To stop an index running in the background use `packse index down`:
+Packse will watch for changes to the `scenarios` directory, and publish new versions on each change.
 
-```
-packse index down
-```
+Note when developing, it is often useful to use the `--no-hash` flag to avoid having to determine the latest
+hash for the scenario.
 
-### Serving scenarios
+### Building a package index
 
-_Requires installation with the `serve` extra_
+_Requires installation with the `index` extra_
 
-The `serve` command can be used to host, build, and publish scenarios in one step.
+Packse can build a file tree that can be served statically, for example, through GitHub Pages, that serve both
+the scenarios and the vendored build dependencies, using the `index` command:
 
 ```bash
-packse serve scenarios
+packse index build
 ```
 
-Packse will watch for changes to the `scenarios` directory, and publish new versions on each change.
+This creates three directories in `./index`:
 
-Note when developing, it is often useful to use the `--no-hash` flag to avoid having to determine the latest
-hash for the scenario.
+ * `./index/files`: The distributions.
+ * `./index/simple-html`: The simple HTML index (PEP 503).
+ * `./index/vendor`: A flat index of build dependencies.
 
 ### Testing scenarios
 
@@ -189,7 +167,7 @@ Published scenarios can then be tested with your choice of package manager.
 For example, with `pip`:
 
 ```bash
-pip install -i https://test.pypi.org/simple/ example-cd797223
+pip install -i https://astral-sh.github.io/packse/548262f/simple-html/ example-cd797223
 ```
 
 ### Exporting scenarios

pyproject.toml

@@ -27,7 +27,7 @@ dependencies = [
   "hatchling>=1.20.0",
   "chevron-blue>=0.2.1",
   "pyyaml>=6.0.1",
-  "uv>=0.4.17",
+  "uv>=0.8",
 ]
 
 [build-system]
@@ -38,7 +38,11 @@ build-backend = "hatchling.build"
 packse = "packse.cli:entrypoint"
 
 [project.optional-dependencies]
-index = ["pypiserver>=2.0.1"]
+index = [
+    "fastapi>=0.116.1",
+    "starlette>=0.47.3",
+    "uvicorn>=0.35.0",
+]
 serve = ["packse[index]", "watchfiles>=0.21.0"]
 
 [tool.uv]