git-annex 10.20250520b1__py3-none-win_amd64.whl → 10.20250520b3__py3-none-win_amd64.whl

git_annex/__init__.py

@@ -4,6 +4,20 @@ import sys
 
 
 def cli():
+    """Emulate a symlink to a binary.
+
+    This script essentially calls the `git-annex` binary that is shipped
+    with the package, but using the `argv` list (including a potentially
+    different executable name) pass to the script itself.
+
+    It relies on the `executable` argument of `subprocess.run()` to achieve
+    this.
+
+    This approach provides alternative means for git-annex's installation
+    method with symlinks pointing to a single binary, and works on platforms
+    without symlink support, and also in packages that cannot represent
+    symlinks.
+    """
     exe_dir = op.dirname(__file__)
     exe = op.join(
         exe_dir,
@@ -23,7 +37,7 @@ def cli():
         # try flush here to trigger a BrokenPipeError
         # within the try-except block so we can handle it
         # (happens if the calling process closed stdout
-        # already
+        # already)
         sys.stdout.flush()
     except BrokenPipeError:
         # setting it to None prevents Python from trying to

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-annex
-Version: 10.20250520b1
+Version: 10.20250520b3
 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.20250520b3.dist-info/RECORD

@@ -0,0 +1,10 @@
+git_annex/__init__.py,sha256=jf81cahptAkcvJ28RYAhZ8FEsKJsGwmbTyjTW6Jq2iM,1519
+git_annex/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+git_annex/git-annex.exe,sha256=fDzctuiD05wz0ZUlEf7pLWlSSodw5mp77MbA-Xtx5FA,96280576
+git_annex/libgnurx-0.dll,sha256=sVYpwWNjXDE3aE6FOtBJNmxt6lYkg3hMNZX3dzYa32g,382387
+git_annex/libmagic-1.dll,sha256=rbOyhepldi0AEIwbE67uxXJHL3wMYdavKn7gatftMS8,1225472
+git_annex/magic.mgc,sha256=_HtmpGIkc8M__H5mrJUJsbCJgZoGQURBbcDmLopuDRk,4873104
+git_annex-10.20250520b3.dist-info/METADATA,sha256=oSi0YBEeYlpgonZrbdkWSeUy_stsSTm8xyYc_RnPgqs,4533
+git_annex-10.20250520b3.dist-info/WHEEL,sha256=Vhj7RpPOKCXcsr4rUs7q4pISuo5nT6VsOuaQwH9GILY,94
+git_annex-10.20250520b3.dist-info/entry_points.txt,sha256=BI1LqRvI7ETq6hOuPgaT9O9cmmHJwYS3SthvRoNS43s,146
+git_annex-10.20250520b3.dist-info/RECORD,,

git_annex-10.20250520b1.dist-info/RECORD

@@ -1,10 +0,0 @@
-git_annex/__init__.py,sha256=ozwI6nWR3OmsbQXD0sDA7M6cWcE4UtUYtkd0VzpIFUI,928
-git_annex/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-git_annex/git-annex.exe,sha256=fr7x6u6tNBq2fWDtDNVeCOXYjVRfhYiNgl-HkPK3nlk,96238592
-git_annex/libgnurx-0.dll,sha256=sVYpwWNjXDE3aE6FOtBJNmxt6lYkg3hMNZX3dzYa32g,382387
-git_annex/libmagic-1.dll,sha256=rbOyhepldi0AEIwbE67uxXJHL3wMYdavKn7gatftMS8,1225472
-git_annex/magic.mgc,sha256=_HtmpGIkc8M__H5mrJUJsbCJgZoGQURBbcDmLopuDRk,4873104
-git_annex-10.20250520b1.dist-info/METADATA,sha256=9DVQfuOcyVU-PYxViqj8HwqwLpT-FDOQTZPOATLjSyg,2832
-git_annex-10.20250520b1.dist-info/WHEEL,sha256=Vhj7RpPOKCXcsr4rUs7q4pISuo5nT6VsOuaQwH9GILY,94
-git_annex-10.20250520b1.dist-info/entry_points.txt,sha256=BI1LqRvI7ETq6hOuPgaT9O9cmmHJwYS3SthvRoNS43s,146
-git_annex-10.20250520b1.dist-info/RECORD,,