Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ if __name__ == "__main__":
app.listen(host="127.0.0.1", port=8000)
```

Install the canonical SmallOS master dependency, the package, and test tools:
Install the pinned SmallOS v1.2.0 release, the package, and test tools:

```console
python3 -m pip install -r requirements.txt
Expand Down
12 changes: 7 additions & 5 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,13 @@ python3 -m twine check dist/*
## Publishing boundary

The automated process creates a GitHub release; it does not publish to PyPI.
SmallServer currently installs SmallOS from its canonical Git `master` branch
SmallServer currently installs the canonical SmallOS `v1.2.0` GitHub release
through `requirements.txt`, while `pyproject.toml` intentionally has no runtime
dependency declaration. Publishing the wheel to PyPI before SmallOS has an
installable release dependency would give users an incomplete installation.
installable package-index dependency would give users an incomplete
installation.

Add PyPI trusted publishing only after SmallOS has a stable package release,
SmallServer declares that dependency in `pyproject.toml`, and an installed-wheel
test proves a clean environment receives every runtime dependency.
Add PyPI trusted publishing only after SmallOS has a stable package-index
release, SmallServer declares that dependency in `pyproject.toml`, and an
installed-wheel test proves a clean environment receives every runtime
dependency.
2 changes: 1 addition & 1 deletion guide/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Set up

Use Python 3.10 or newer and install the canonical SmallOS master checkout plus
Use Python 3.10 or newer and install the pinned SmallOS v1.2.0 release plus
SmallServer in editable mode:

```console
Expand Down
11 changes: 6 additions & 5 deletions guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,18 @@

## Requirements

SmallServer requires Python 3.10 or newer. During development,
`requirements.txt` installs SmallOS from the canonical GitHub `master` branch;
SmallServer itself declares no package-index runtime dependency yet.
SmallServer requires Python 3.10 or newer. `requirements.txt` installs the
canonical SmallOS GitHub release tagged `v1.2.0`; SmallServer itself declares
no package-index runtime dependency yet.

```console
python3 -m pip install -r requirements.txt
python3 -m pip install -e .
```

The first command needs Git and network access. Pin the SmallOS revision in
your own deployment lock or build process if reproducibility matters.
The first command needs Git and network access. The release tag makes the
SmallOS source revision reproducible; deployments should still lock all of
their transitive build dependencies.

## Create an application

Expand Down
7 changes: 4 additions & 3 deletions guide/platforms-kernels.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@ that runtime, and starts it. If the dependency or Unix kernel is unavailable,
it raises `ServerConfigurationError` and asks the caller to provide a suitable
runtime.

The canonical SmallOS dependency is installed from GitHub `master` by
`requirements.txt`. Python package metadata intentionally has no runtime
dependency until SmallOS has an unambiguous published distribution contract.
The canonical SmallOS dependency is installed from the GitHub `v1.2.0` release
tag by `requirements.txt`. Python package metadata intentionally has no runtime
dependency until SmallOS has an unambiguous package-index distribution
contract.

## Custom and constrained kernels

Expand Down
6 changes: 3 additions & 3 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Install SmallOS directly from its canonical master branch. The PyPI package
# name is not yet available to this project.
-e git+https://github.com/MikiEEE/SmallOS.git@master#egg=SmallPackage
# Install the canonical SmallOS v1.2.0 GitHub release. The distribution is not
# yet consumed from a package index by this project.
SmallPackage @ git+https://github.com/MikiEEE/SmallOS.git@v1.2.0
Loading