vibesketch.codenames¶
Release codename catalogue.
vibe-sketch names releases after an organic chemist with a named reaction
and a piece of laboratory equipment. The maintainer selected Dötz’s Flask
for 0.1.2 and later 0.1.x patches (docs/codenames.md). An explicit patch
entry starts a new name within its minor line without renaming older versions.
Registration accompanies the release version commit.
This module is the single source of truth. Three surfaces read it:
vibe-sketch --version(vibesketch.cli)the server’s
/api/versionresource, which the browser’s About box and the Electron desktop shell displaythe documentation site’s
{{codename}}substitution (docs/conf.pyloads this file standalone, so it must keep importing nothing beyond the standard library)
tests/test_codenames.py checks that every surface agrees with the
catalogue.
Programmatic API¶
codename_for_version(version)Resolve a version string to its codename, or
None.codename_for_current()Convenience: the codename of the running
vibesketch.__version__.version_label()The
"0.1.2 — Dötz’s Flask"string the user-facing surfaces print, or the bare version while no codename is registered.
Functions
Return the codename of the running vibe-sketch, or |
|
|
Return the codename for a vibe-sketch release version, or |
|
Format the version string the user-facing surfaces print. |
- vibesketch.codenames.codename_for_current()[source]¶
Return the codename of the running vibe-sketch, or
None.Imported lazily so this module stays importable with nothing but the standard library:
docs/conf.pyloads it by path, outside the package.- Return type:
str | None
- vibesketch.codenames.codename_for_version(version)[source]¶
Return the codename for a vibe-sketch release version, or
None.Resolution order:
Strip any PEP-440
.devN/aN/bN/rcNsuffix and local version label, so a dev build inherits the codename of the release it leads up to.Direct lookup of the resulting
X.Y.ZinRELEASE_CODENAMES.Use the most recent named version no later than
X.Y.Zin the same minor line, so subsequent patches inherit a patch-level change.Nonewhen no codename is registered for that minor.