git-annex 10.20250520b1__py3-none-macosx_13_0_x86_64.whl → 10.20250520b2__py3-none-macosx_13_0_x86_64.whl

{git_annex-10.20250520b1.dist-info → git_annex-10.20250520b2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-annex
-Version: 10.20250520b1
+Version: 10.20250520b2
 Summary: manage files with git, without checking their contents into git
 Project-URL: Homepage, https://git-annex.branchable.com/
 Project-URL: Documentation, https://git-annex.branchable.com/git-annex
@@ -35,7 +35,37 @@ Description-Content-Type: text/markdown
 
 # Python wheel package for git-annex
 
-https://pypi.org/project/git-annex/
+## Why?
+
+[Git-annex](https://git-annex.branchable.com/) is written in Haskell and plenty
+of [installation methods](https://git-annex.branchable.com/install/) are
+available. However, for deploying git-annex as a dependency of a Python
+library/application, like [DataLad](https://datalad.org) or
+[AnnexRemote](https://github.com/Lykos153/AnnexRemote), system packages
+are a lot less flexible than Python's virtual environments, and other methods
+are more complex and fragile.
+
+With git-annex being available from PyPi, versioned dependencies and deployment
+in application-specific environments are possible via standard means of Python
+packaging.
+
+## Caveats
+
+A standard git-annex deployment is (primarily) a single binary (`git-annex`),
+and a bunch of symlinks that make this one binary fulfilled multiple roles
+(`git-annex-shell`, `git-remote-annex`, etc.). A Python wheel, however, is a
+ZIP file container with no support for symlinks, and also no support for
+"post-install" scripts.
+
+In order to square this circle, the git-annex binary is wrapped via regular
+Python entrypoint scripts that handle calling git-annex as necessary. This
+delivers a cross-platform compatible wheel, but at a start-up cost (~30ms vs
+~11ms on my laptop).
+
+## Installation
+
+Get the package from [PyPi](https://pypi.org/project/git-annex/), and install like
+any other package from PyPi.
 
 [uv](https://docs.astral.sh/uv/) users can deploy git-annex in a dedicated virtual
 environment via the one-liner:
@@ -44,6 +74,8 @@ environment via the one-liner:
 uv tool install git-annex
 ```
 
+## git-annex build configuration
+
 Git-annex is built with libmagic support, but without the git-annex assistant.
 The primary purpose of this package is to provide git-annex (as a dependency),
 installed in a virtual environment. Users of the git-annex assistant application
@@ -73,4 +105,11 @@ to be deployed separately.
 
 ### How to update for a new git-annex release?
 
-TODO
+Advance the submodule `./git-annex` to the new release tag.
+
+Now adjust the package version in `pyproject.toml` accordingly. This version
+must follow the [rules for Python
+packages](https://packaging.python.org/en/latest/discussions/versioning/).
+
+The included (GitHub) action workflows will build a corresponding wheel
+and upload it to PyPi.

git_annex-10.20250520b2.dist-info/RECORD

@@ -0,0 +1,7 @@
+git_annex/__init__.py,sha256=j8qJxYY0WVQQP8IXmkSBZQ2nPswrOrwpzPjBQ4VEfrk,895
+git_annex/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+git_annex/git-annex,sha256=ksMB-E7IZGqmusHRbclqmIj0ntow3aQB8fhHnGlTr88,49298392
+git_annex-10.20250520b2.dist-info/METADATA,sha256=5zF9nF8WvaYQQc5AtHly37eCcUHH_76Fe0XDtkL8dsY,4533
+git_annex-10.20250520b2.dist-info/WHEEL,sha256=Mg9ffUKlLAZ3neFxGovlcxZht42vBGUz9HUbsaBtTmM,103
+git_annex-10.20250520b2.dist-info/entry_points.txt,sha256=BI1LqRvI7ETq6hOuPgaT9O9cmmHJwYS3SthvRoNS43s,146
+git_annex-10.20250520b2.dist-info/RECORD,,

git_annex-10.20250520b1.dist-info/RECORD

@@ -1,7 +0,0 @@
-git_annex/__init__.py,sha256=j8qJxYY0WVQQP8IXmkSBZQ2nPswrOrwpzPjBQ4VEfrk,895
-git_annex/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-git_annex/git-annex,sha256=6VbsZeokU-SFFLIXC0z7piQcIeUsCOhyLKYcI4vPeko,49298272
-git_annex-10.20250520b1.dist-info/METADATA,sha256=9DVQfuOcyVU-PYxViqj8HwqwLpT-FDOQTZPOATLjSyg,2832
-git_annex-10.20250520b1.dist-info/WHEEL,sha256=Mg9ffUKlLAZ3neFxGovlcxZht42vBGUz9HUbsaBtTmM,103
-git_annex-10.20250520b1.dist-info/entry_points.txt,sha256=BI1LqRvI7ETq6hOuPgaT9O9cmmHJwYS3SthvRoNS43s,146
-git_annex-10.20250520b1.dist-info/RECORD,,