livery-extensions-lfs 0.0.0__tar.gz

livery_extensions_lfs-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Willem Kokke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

livery_extensions_lfs-0.0.0/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.4
+Name: livery-extensions-lfs
+Version: 0.0.0
+Summary: Git LFS for the livery workshop: the git-lfs tool locked, its hooks installed by every sync, and the LFS objects fetched by the rendered CI checkout.
+Author: Willem Kokke
+Author-email: Willem Kokke <mail@willem.net>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
+Requires-Dist: livery-footman>=0.61.0
+Requires-Dist: livery-toolroom>=0.12.0
+Requires-Dist: livery-workshop>=0.11.0
+Requires-Python: >=3.11
+Project-URL: Repository, https://github.com/willemkokke/livery
+Description-Content-Type: text/markdown
+
+# livery-extensions-lfs
+
+Git LFS for the livery workshop. Listed as `lfs` in a workspace's
+`[workspace] extensions`, it pins git-lfs in the lock, installs LFS's
+hooks and filter in the checkout on every `fm sync`, and makes the
+rendered CI checkout fetch the LFS objects.

livery_extensions_lfs-0.0.0/README.md

@@ -0,0 +1,6 @@
+# livery-extensions-lfs
+
+Git LFS for the livery workshop. Listed as `lfs` in a workspace's
+`[workspace] extensions`, it pins git-lfs in the lock, installs LFS's
+hooks and filter in the checkout on every `fm sync`, and makes the
+rendered CI checkout fetch the LFS objects.

livery_extensions_lfs-0.0.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["uv_build>=0.11,<0.13"]
+build-backend = "uv_build"
+
+[project]
+name = "livery-extensions-lfs"
+version = "0.0.0"
+description = "Git LFS for the livery workshop: the git-lfs tool locked, its hooks installed by every sync, and the LFS objects fetched by the rendered CI checkout."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Typing :: Typed",
+]
+dependencies = [
+    "livery-footman>=0.61.0",
+    "livery-toolroom>=0.12.0",
+    "livery-workshop>=0.11.0",
+]
+
+[[project.authors]]
+name = "Willem Kokke"
+email = "mail@willem.net"
+
+[project.urls]
+Repository = "https://github.com/willemkokke/livery"
+
+[project.entry-points."workshop.extensions"]
+lfs = "livery.extensions.lfs"
+
+[tool.uv.build-backend]
+module-name = "livery.extensions.lfs"
+namespace = true

livery_extensions_lfs-0.0.0/pyproject.toml.orig

@@ -0,0 +1,41 @@
+# The package's own: edit it directly, nothing rewrites it.
+[build-system]
+requires = ["uv_build>=0.11,<0.13"]
+build-backend = "uv_build"
+
+[project]
+name = "livery-extensions-lfs"
+version = "0.0.0"
+description = "Git LFS for the livery workshop: the git-lfs tool locked, its hooks installed by every sync, and the LFS objects fetched by the rendered CI checkout."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+authors = [{ name = "Willem Kokke", email = "mail@willem.net" }]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Typing :: Typed",
+]
+dependencies = [
+    "livery-footman>=0.61.0",
+    "livery-toolroom>=0.12.0",
+    "livery-workshop>=0.11.0",
+]
+
+[project.urls]
+Repository = "https://github.com/willemkokke/livery"
+
+# The name a workspace lists in [workspace] extensions, and the package
+# whose extension.toml the workshop mounts it from. Nothing else: the
+# extension adds no verb of its own, and nothing activates by being
+# installed.
+[project.entry-points."workshop.extensions"]
+lfs = "livery.extensions.lfs"
+
+[tool.uv.build-backend]
+# PEP 420 namespace: the importable package is livery.extensions.lfs and
+# there is no livery/__init__.py anywhere in this repository.
+module-name = "livery.extensions.lfs"
+namespace = true

livery_extensions_lfs-0.0.0/src/livery/extensions/lfs/_docs/index.md

@@ -0,0 +1,50 @@
+# livery-extensions-lfs
+
+Git LFS for the workshop. A workspace turns it on by listing the
+extension:
+
+```toml
+[workspace]
+extensions = ["lfs"]
+```
+
+Listed, it does three things:
+
+- The lock pins `git_lfs`, the git-lfs tool, so every machine and every
+  CI job runs the same release of it.
+- Every `fm sync` runs `git lfs install --local` once over the
+  workspace, after it installs the tools. That writes LFS's hooks and
+  the checkout's filter configuration where they are missing, so a sync
+  that finds them in place changes nothing. A failure stops the sync
+  with git-lfs's own words. A workspace that is not a git checkout gets
+  nothing.
+- The checkout step of the rendered GitHub and Gitea workflows sets
+  `lfs: true`, so a job reads the files and not their pointers. GitLab's
+  runner fetches the LFS objects by itself where its image has git-lfs.
+
+A workspace that does not list the extension gets none of the three.
+
+## Attribute lines
+
+The extension ships no attribute line of its own: the extension that
+ships a kind of file says which of them go through LFS. It ships the
+lines in `content/for/lfs/root/.gitattributes`, beside its
+`extension.toml`, and declares a `[for.lfs]` table there:
+
+```toml
+[for.lfs]
+```
+
+```text
+*.png filter=lfs diff=lfs merge=lfs -text
+```
+
+`fm sync` composes those lines into the root `.gitattributes` while the
+workspace lists `lfs`, and removes them when it stops listing it. A root
+entry's `without` keeps one extension's lines out while `lfs` stays
+listed:
+
+```toml
+[workspace]
+extensions = [{ name = "assets", without = ["lfs"] }, "lfs"]
+```

livery_extensions_lfs-0.0.0/src/livery/extensions/lfs/_docs/nav.toml

@@ -0,0 +1,12 @@
+# This package's section of the workspace site, hand-authored.
+# Labels map to pages relative to this docs/ tree, or to nested
+# lists. Every authored page must appear here, and every entry must
+# name a real page. A generator owns a block between `# nav:begin
+# <name>` and `# nav:end <name>` markers (tasks, tools); the emitter's
+# own sections, changelog, coverage and api, are blocks too: place a
+# pair where one belongs, and a section without one lands after the
+# authored entries, changelog and coverage ahead of the tasks block,
+# api last.
+nav = [
+    { "Index" = "index.md" },
+]

livery_extensions_lfs-0.0.0/src/livery/extensions/lfs/_hooks.py

@@ -0,0 +1,33 @@
+"""Install Git LFS's hooks and filter configuration in the checkout: the sync step."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from livery.footman import fail
+
+if TYPE_CHECKING:
+    from livery.workshop import PhaseContext
+
+
+def install(ctx: PhaseContext) -> None:
+    """Install LFS's hooks and filter configuration in the checkout at the root.
+
+    ``git lfs install --local`` writes the hooks and the checkout's
+    filter configuration only where they are missing, so a sync that
+    finds them in place changes nothing. A workspace that is not a git
+    checkout gets nothing.
+
+    Raises:
+        Failed: when ``git lfs install --local`` exits non-zero, with
+            git-lfs's own words.
+    """
+    import livery.toolroom.tools as tools
+
+    if not (ctx.root / ".git").exists():
+        return
+    result = tools.git_lfs.opts(cwd=ctx.root, nofail=True, recorded=False)(
+        "install", "--local"
+    )
+    if result.code != 0:
+        fail(f"git lfs install --local failed: {result.stderr.strip()}")

livery_extensions_lfs-0.0.0/src/livery/extensions/lfs/extension.toml

@@ -0,0 +1,23 @@
+# The lfs extension: Git LFS for the workspace. Read at every mount; the
+# sync step's code is imported when it runs. An extension that ships an
+# LFS attribute line ships it under content/for/lfs/ with a [for.lfs]
+# table, so the line applies while this extension is listed.
+
+[extension]
+description = "Git LFS for the workspace: the lock pins git-lfs, every fm sync installs LFS's hooks and filter in the checkout, and the rendered CI checkout fetches the LFS objects."
+api-version = 1
+
+# git-lfs runs the hooks and the filter the sync step installs, so the
+# lock pins it while the workspace lists this extension.
+[toolroom]
+requires = ["git_lfs"]
+
+# Once over the workspace on every fm sync, after the tools are
+# installed: LFS's hooks and the checkout's filter configuration.
+[phases.sync.lfs]
+main = "livery.extensions.lfs._hooks:install"
+
+# The rendered CI checkout fetches the LFS objects, or the gate reads
+# the pointer files where the files should be.
+[queries.checkout-inputs]
+value = { lfs = "true" }