tuieval 0.1.7__tar.gz → 0.2.0.dev1__tar.gz

{tuieval-0.1.7 → tuieval-0.2.0.dev1}/.gitignore

@@ -11,3 +11,4 @@ dist/
 /logs/
 /tuning/
 /packs/
+src/tuieval/_version.py

{tuieval-0.1.7 → tuieval-0.2.0.dev1}/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+- Versions come from git tags: a tag `vX.Y.Z` is that release, and every commit on `main` after it is published automatically as a dev build `X.(Y+1).0.devN` (N = commits since the release). `pip install tuieval` keeps installing releases only; `pip install --pre tuieval` gets the latest build.
+
 ## 0.1.7 (replaces 0.1.6, withdrawn)
 
 - `tuieval tune` starts warm for fine-tunes: when a model with the same architecture and tensor shapes is already tuned on this machine, its flags are the starting point and only speculative decoding and micro-batch are re-tried (~4-6 server starts instead of 8-15). It tunes in full if the inherited flags fail, change answers or are slower than the defaults. `--cold` (or `[tune] warm_start = false`) always tunes in full; `[tune] warm_retest` names the re-tried knobs.

{tuieval-0.1.7 → tuieval-0.2.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: tuieval
-Version: 0.1.7
+Version: 0.2.0.dev1
 Summary: Evaluate local and frontier LLMs on your own questions: accuracy, speed, tokens and PASS/FAIL verdicts, in the terminal.
 Project-URL: Homepage, https://github.com/ashe-wb/tuieval
 Project-URL: Issues, https://github.com/ashe-wb/tuieval/issues
@@ -43,6 +43,8 @@ tuieval add ~/models/Some-Model-Q4_K_M.gguf
 tuieval                        # open the TUI
 ```
 
+`pip install tuieval` gets the latest release. Every change on `main` is also published as a dev build (`X.Y.0.devN`); get it with `pipx install --pip-args=--pre tuieval` or `pip install --pre tuieval`.
+
 Once you've added your own packs and models, the setup screen looks like this (packs on the left, models with a verdict code per use case on the right, the highlighted model's details below):
 
 ![tuieval's setup screen with five eval packs and a dozen local models](https://raw.githubusercontent.com/ashe-wb/tuieval/main/docs/images/tui-setup.png)

{tuieval-0.1.7 → tuieval-0.2.0.dev1}/README.md

@@ -17,6 +17,8 @@ tuieval add ~/models/Some-Model-Q4_K_M.gguf
 tuieval                        # open the TUI
 ```
 
+`pip install tuieval` gets the latest release. Every change on `main` is also published as a dev build (`X.Y.0.devN`); get it with `pipx install --pip-args=--pre tuieval` or `pip install --pre tuieval`.
+
 Once you've added your own packs and models, the setup screen looks like this (packs on the left, models with a verdict code per use case on the right, the highlighted model's details below):
 
 ![tuieval's setup screen with five eval packs and a dozen local models](https://raw.githubusercontent.com/ashe-wb/tuieval/main/docs/images/tui-setup.png)

tuieval-0.2.0.dev1/RELEASING.md

@@ -0,0 +1,31 @@
+# Releasing
+
+Versions come from git (hatch-vcs). Nobody edits a version number by hand.
+
+| What | Version | Who gets it |
+|---|---|---|
+| A tag `vX.Y.Z` | `X.Y.Z` | `pip install tuieval` |
+| Every other commit on `main` | `X.(Y+1).0.devN`, N = commits since the last tag | `pip install --pre tuieval` |
+
+CI (`.github/workflows/test.yml`) runs the tests on every push. When they pass, the `publish` job builds the package, checks it with `twine check`, and uploads it to PyPI with trusted publishing (no token is stored anywhere): every push to `main` as a dev build, every `v*` tag as a release.
+
+## Day to day
+
+1. Commit and push to `main`. Add a line under `## Unreleased` in `CHANGELOG.md` for anything users would notice.
+2. CI publishes the dev build. Check it: `pipx install --force --pip-args=--pre tuieval && tuieval --version`.
+
+## A release
+
+Cut one when there's something worth announcing, not for every change. Semantic versioning: PATCH for fixes, MINOR for features (and anything that changes behaviour while the major version is 0), MAJOR for breaking changes after 1.0.
+
+1. In `CHANGELOG.md`, rename `## Unreleased` to `## X.Y.Z` and add a new empty `## Unreleased` above it. Commit and push.
+2. Tag that commit and push the tag: `git tag -a vX.Y.Z -m "X.Y.Z" && git push origin vX.Y.Z`.
+3. CI publishes `X.Y.Z`. Check a fresh install: `pipx install --force tuieval==X.Y.Z && tuieval --version`.
+
+## One-time setup (done once per PyPI project)
+
+On PyPI, under the project's Publishing settings, add a trusted publisher: owner `ashe-wb`, repository `tuieval`, workflow `test.yml`, environment `pypi`.
+
+## Building by hand
+
+`python -m pip install build twine && python -m build && twine check dist/*`. A build needs the git history and tags (a full clone), or it can't tell its version.

{tuieval-0.1.7 → tuieval-0.2.0.dev1}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["hatchling>=1.24"]
+requires = ["hatchling>=1.24", "hatch-vcs>=0.4"]
 build-backend = "hatchling.build"
 
 [project]
@@ -37,8 +37,17 @@ tuieval = "tuieval.cli:main"
 Homepage = "https://github.com/ashe-wb/tuieval"
 Issues = "https://github.com/ashe-wb/tuieval/issues"
 
+# The version comes from git: a tag vX.Y.Z is that release; every commit after it on main is
+# X.(Y+1).0.devN, N = commits since the tag (see RELEASING.md).
 [tool.hatch.version]
-path = "src/tuieval/__init__.py"
+source = "vcs"
+
+[tool.hatch.version.raw-options]
+version_scheme = "release-branch-semver"
+local_scheme = "no-local-version"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/tuieval/_version.py"
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/tuieval"]

tuieval-0.2.0.dev1/src/tuieval/__init__.py

@@ -0,0 +1,5 @@
+"""tuieval: evaluate local and frontier models on your own eval packs, in the terminal."""
+try:
+    from ._version import __version__   # written by the build from the git tag (RELEASING.md)
+except ImportError:                      # a source tree that was never built or installed
+    __version__ = "0+unknown"

tuieval-0.2.0.dev1/src/tuieval/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.2.0.dev1'
+__version_tuple__ = version_tuple = (0, 2, 0, 'dev1')
+
+__commit_id__ = commit_id = None

tuieval-0.1.7/RELEASING.md

@@ -1,7 +0,0 @@
-# Releasing
-
-1. Bump `__version__` in `src/tuieval/__init__.py` and add a `CHANGELOG.md` entry.
-2. Commit, push, and wait for CI to pass.
-3. Build from a clean checkout and check: `python -m pip install build twine && python -m build && twine check dist/*`
-4. Publish to PyPI: `twine upload dist/*` (username `__token__`, password: a PyPI API token).
-5. Check a fresh install: `pipx install --force tuieval==<version> && tuieval --version`

tuieval-0.1.7/src/tuieval/__init__.py

@@ -1,2 +0,0 @@
-"""tuieval: evaluate local and frontier models on your own eval packs, in the terminal."""
-__version__ = "0.1.7"