mirror of https://github.com/luxfhe/torus.git synced 2026-10-30 17:07:26 +00:00

Files

T

zeekay 897660a036 Name this project in its own headers, URLs and workflows

File headers named a licence the repo does not carry ("BSD3 with Zama
Exceptions" against a BSD 3-Clause Clear LICENSE), include guards kept the
upstream ZAMALANG_ prefix, and repository and image URLs still pointed at
the upstream org.

References to genuinely third-party projects are left alone — the pinned
slab-github-runner action, the slab repository and tfhe-rs are other
people's code, and rewriting those names would invent URLs that resolve to
nothing. Attribution stays where it belongs, in NOTICE and in the LICENSE
files themselves.

2026-08-27 13:17:39 -07:00

2.7 KiB

Raw Permalink Blame History

Publishing Torus

This document covers how Torus reaches its distribution channels. There is exactly one way to ship each artefact; everything else is a draft.

PyPI — `torus-fhe`

The frontends/torus-python/ package is published to PyPI as torus-fhe (the project name is set in frontends/torus-python/pyproject.toml).

One-time setup (operator)

Generate a scoped PyPI API token at https://pypi.org/manage/account/token/.
- Scope: project torus-fhe (after the first manual upload reserves the name) or "Entire account" for the inaugural push.
Add it to the luxfhe/torus GitHub repo as a secret named PYPI_API_TOKEN (Settings → Secrets and variables → Actions → New repository secret).
Create a GitHub environment called pypi and gate it on a required reviewer if release approval is desired. The torus-pypi workflow references this environment.

Release flow (each version)

Bump frontends/torus-python/version.txt (the source of truth for setup.py's version() helper).
Commit on main.
Tag and push:
```
git tag v0.1.0
git push origin v0.1.0
```
The .github/workflows/torus-pypi.yml workflow fires on the v* tag, builds an sdist + wheel via pypa/build, and uploads with pypa/gh-action-pypi-publish@release/v1. skip-existing: true makes the step idempotent if the same version was already uploaded out-of-band.

Versioning rules

Patch bumps only between releases (e.g. v0.1.0 → v0.1.1). Never jump a major or minor unless the change is genuinely API-breaking.
The Torus version is decoupled from the upstream Torus history; we start at v0.1.0 on first publish.

What is NOT yet automated

Native bindings: the wheel produced by this workflow is currently a pure-Python distribution. The full cross-platform wheel matrix (manylinux
- macOS arm64/x86_64) for the compiled toruslang_core bindings is a follow-up. Until it lands, GPU/FPGA users build from source via compilers/torus-compiler/.
PyPI trusted publishing: the workflow uses a long-lived API token. A later pass should migrate to OIDC trusted publishing (no secret needed) via the same environment hook.

GitHub container images

Compiler and runtime container images are pushed to GHCR under ghcr.io/luxfhe/torus-* by the existing per-component workflows in .github/workflows/. See docker/ for the source Dockerfiles.

Documentation

docs.luxfhe.com/torus is built from docs/; the API reference under docs/dev/api is generated by .github/workflows/scripts/make_apidocs.sh. refresh_pypi.yml is a different job — it rebuilds the PyPI index and invalidates its cache, and publishes no documentation.

2.7 KiB Raw Permalink Blame History