uv-pack 0.0.1__py3-none-any.whl → 0.1.1__py3-none-any.whl

uv_pack-0.1.1.dist-info/METADATA

@@ -0,0 +1,210 @@
+Metadata-Version: 2.3
+Name: uv-pack
+Version: 0.1.1
+Summary: Pack you uv environment for offline usage.
+Author: David Muhr
+Author-email: David Muhr <muhrdavid+github@gmail.com>
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Education
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Classifier: Typing :: Typed
+Requires-Dist: packaging>=24.0
+Requires-Dist: requests>=2
+Requires-Dist: typer>=0.19
+Requires-Python: >=3.10
+Project-URL: source, https://github.com/davnn/uv-pack
+Project-URL: tracker, https://github.com/davnn/uv-pack/issues
+Project-URL: release notes, https://github.com/davnn/uv-pack/releases
+Description-Content-Type: text/markdown
+
+uv-pack
+=======
+
+[![Check Status](https://github.com/davnn/uv-pack/actions/workflows/check.yml/badge.svg)](https://github.com/davnn/uv-pack/actions?query=workflow%3Acheck)
+[![Semantic Versions](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--versions-e10079.svg)](https://github.com/davnn/uv-pack/releases)
+
+Bundle a locked `uv` environment into a self-contained, offline-installable directory.
+The output includes pinned requirements, third-party wheels, locally built wheels,
+and a portable Python interpreter.
+
+What it does
+------------
+- Exports locked requirements from your `uv` lock file.
+- Downloads third-party wheels into `pack/wheels/`.
+- Builds local workspace packages into `pack/vendor/`.
+- Downloads a python-build-standalone archive into `pack/python/` (unless you skip the `python` step).
+- Writes `unpack.sh`, `unpack.ps1`, and `unpack.cmd` to unpack the resulting venv offline.
+
+Install
+-------
+
+Install `uv-pack` as a dev-dependency.
+
+```bash
+uv add --dev uv-pack
+```
+
+Once installed, run using:
+
+```bash
+uv run uv-pack --help
+```
+
+You can also use ``uv-pack`` as a tool.
+
+```bash
+# specify the python version!
+uv tool run --python 3.12 uv-pack --help
+# or using uvx (equivalent)
+uvx --python 3.12 uv-pack --help
+```
+
+CLI
+---
+
+```bash
+uv-pack [STEPS...]
+```
+
+Options:
+- `STEPS`: subset of pipeline steps (default: `clean export download build python`)
+- `-s, --skip`: skip a pipeline step (can be supplied multiple times)
+- `-o, --output-directory`: path to output directory (default: `./pack`)
+- `-v, --verbose`: show more detailed pack progress logging
+- `--uv-build`: extra args passed to `uv build`
+- `--uv-export`: extra args passed to `uv export`
+- `--pip-download`: extra args passed to `pip download`
+
+Pipeline steps:
+- `clean`: remove the output directory
+- `export`: write `requirements.txt` files for third-party and local packages
+- `download`: download third-party wheels and sources
+- `build`: build local wheels and compile the combined requirements file
+- `python`: download a python-build-standalone archive for the current Python version and platform
+
+Example
+-------
+```bash
+# run the entire pipeline (default) with verbose outputs
+uv-pack --verbose
+# only clean and export the requirements
+uv-pack clean export
+```
+
+Output layout
+-------------
+```
+pack/
+  requirements.txt
+  wheels/
+    requirements.txt
+  vendor/
+    requirements.txt
+  python/   # (omitted when the python step is skipped)
+  unpack.sh
+  unpack.ps1
+  unpack.cmd
+  .gitignore
+  README.md
+```
+
+Unpack and install offline
+--------------------------
+
+POSIX (sh/bash/zsh):
+
+```bash
+./pack/unpack.sh
+```
+
+PowerShell:
+
+```powershell
+.\pack\unpack.ps1
+```
+
+Windows cmd:
+
+```cmd
+.\pack\unpack.cmd
+```
+
+All scripts also accept `VENV_DIR`, `PY_DEST` and `BASE_PY` environment variables.
+Use `BASE_PY` when you skipped the `python` step during packing to provide a system
+python interpreter. `VENV_DIR` (default = `.venv`) and `PY_DEST` (default = `.python`)
+can be used to customize the target python and venv directory.
+
+Configuration
+-------------
+
+`UV_PYTHON_INSTALL_MIRROR` can override the GitHub API endpoint to retrieve the
+Python releases, default is:
+<https://api.github.com/repos/astral-sh/python-build-standalone/releases/latest>.
+
+`GITHUB_TOKEN` can be used to authenticate requests to the GitHub API to
+prevent possible rate-limiting.
+
+Limitations
+-----------
+
+- The pack process must happen in the ``pyproject.toml`` or ``uv.toml`` directory, typically the repository root,
+  because ``uv`` exports relative paths to the project root.
+- The build platform is expected to equal the usage platform; it is currently not possible to pack an environment
+  for a different platform.
+- The project Python version is ignored when running `uv-pack` as a tool (`uv tool run` or `uvx`) and should be
+  specified using `uv tool run --python 3.11 uv-pack` or `uvx --python 3.11 uv-pack`, see
+  [uv#uv5951](https://github.com/astral-sh/uv/issues/5951) and [uv#8206](https://github.com/astral-sh/uv/issues/8206).
+- The download process can be slow because ``pip download`` is used as there is no native (parallel) uv download
+  option available for wheels, see [uv#3163](https://github.com/astral-sh/uv/issues/3163).
+
+FAQ
+-----------
+
+#### How do I pass extra options to `uv export` or another command?
+
+Use `--uv-export` to forward arguments, for example:
+
+- ``uv-pack --uv-export "--package $MY_PACKAGE"`` to export only a specific workspace package
+- ``uv-pack --uv-export "--locked  --dev"`` to include dev-deps and ensure an up-to-date lock file
+- ``uv-pack --uv-export "--all-extras"`` to include all extra dependencies
+
+The same is true for ``--uv-build`` and ``--pip-download`` arguments.
+
+#### How do I specify index-urls and extra-index-urls?
+
+The index urls set in ``pyproject.toml`` and ``uv.toml`` are not configured by default for the wheel
+download (``pip download``), you can specify them as:
+
+- ``uv-pack --pip-download "--index-url $MY_INDEX --extra-index-url $MY_EXTRA_INDEX"``
+
+#### How do I skip bundling Python?
+
+Skip the `python` step: ``uv-pack --skip python``. When unpacking, set `BASE_PY` to a system Python path.
+
+#### How do I rerun without deleting the existing pack directory?
+
+Skip the `clean` step: ``uv-pack --skip clean``. Note that this automatically re-uses downloaded wheels
+and the downloaded Python interpreter.
+
+#### How do I only re-build my package if my pack is already complete?
+
+Run only ``uv-pack build``.
+
+#### How can I use my pack?
+
+Move the pack to the final location and, depending on the shell used, call
+`unpack.sh`, `unpack.ps1`, or `unpack.cmd`. Don't move the virtual
+environment or pack folder after unpacking (hardcoded paths).

uv_pack-0.1.1.dist-info/RECORD

@@ -0,0 +1,19 @@
+uv_pack/__init__.py,sha256=UlBfhHcK1dwn-0NAlJNTef5fFyU7VpFyRIedVA7SF_4,8576
+uv_pack/_build.py,sha256=m6_9JwGWNHA-6zO41Y3CKH5hlUtNBd4WPWOcHSVH2s8,1141
+uv_pack/_download.py,sha256=MDo_O6bhYqAyZNCZI28AcO6T-OZkpaD9wDVkJLQD7dU,1158
+uv_pack/_export.py,sha256=eFLKqUlGOCiG7Z9LUXar1VadXdBGDkxA0to7MMrMpIs,1089
+uv_pack/_files.py,sha256=uhvNW2RLUVVwE7J6LywwlkOHD4TQ3h_vpqvoN59mA2E,1616
+uv_pack/_logging.py,sha256=doIGYthDfOGwqTzCX1ckJnscGR3ZaL8QLy0hgdx8EO0,1066
+uv_pack/_process.py,sha256=qPNQki1Pgu2vLaRsRzXpYmriwghep7HlfI0T5ykX6nY,1928
+uv_pack/_python.py,sha256=KcRQMKwXufNcwS5pY7odcbtK_UihD_CymG5djilBJaE,5577
+uv_pack/_scripts.py,sha256=ju_9XRNw3vx3ShdLV2Cy-e2gVunkD5ZiOL0HuKqRB-g,1521
+uv_pack/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+uv_pack/scripts/README.md,sha256=fFmzFOExIEt0NERw1rBvsi_ur1qT3I-cVCxOBTO_rrQ,1550
+uv_pack/scripts/SPEC.md,sha256=_U31gEyPEZLfrO0u4POqdJLwgAFVzsh80bFd0hXESLU,1724
+uv_pack/scripts/unpack.cmd,sha256=bzxdyYPSN6hEQfVyg0BHJFvMiEvQe7HtGH9GPQOQSVQ,1865
+uv_pack/scripts/unpack.ps1,sha256=ygQkxsIhUfum8uX3LrjAIclfi91IN98jzU-LYEyVgOA,2150
+uv_pack/scripts/unpack.sh,sha256=1cDrzcSJeEnbFM_ZLkNnrWsfBNLRtVYIAC8yiXxFLEg,1751
+uv_pack-0.1.1.dist-info/WHEEL,sha256=iHtWm8nRfs0VRdCYVXocAWFW8ppjHL-uTJkAdZJKOBM,80
+uv_pack-0.1.1.dist-info/entry_points.txt,sha256=vNW2L3ycXru1h_bHFxCKTtzswejxRk6UjhAd26vRLoM,42
+uv_pack-0.1.1.dist-info/METADATA,sha256=5GYO30zrPk_z2tT5wzqNFCLl3FpSfjMQHx8CBnyK34k,6988
+uv_pack-0.1.1.dist-info/RECORD,,

{uv_pack-0.0.1.dist-info → uv_pack-0.1.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.9.26
+Generator: uv 0.9.30
 Root-Is-Purelib: true
 Tag: py3-none-any

uv_pack-0.0.1.dist-info/METADATA

@@ -1,140 +0,0 @@
-Metadata-Version: 2.3
-Name: uv-pack
-Version: 0.0.1
-Summary: Pack you uv environment for offline usage.
-Author: David Muhr
-Author-email: David Muhr <muhrdavid+github@gmail.com>
-Classifier: Development Status :: 3 - Alpha
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Topic :: Scientific/Engineering
-Classifier: Topic :: Utilities
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Science/Research
-Classifier: Intended Audience :: Education
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Operating System :: POSIX
-Classifier: Operating System :: Unix
-Classifier: Operating System :: MacOS
-Classifier: Typing :: Typed
-Requires-Dist: packaging>=26.0
-Requires-Dist: requests>=2.32.5
-Requires-Dist: typer>=0.21.1
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-
-uv-pack
-=======
-
-[![Check Status](https://github.com/davnn/uv-pack/actions/workflows/check.yml/badge.svg)](https://github.com/davnn/uv-pack/actions?query=workflow%3Acheck)
-[![Semantic Versions](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--versions-e10079.svg)](https://github.com/davnn/uv-pack/releases)
-
-Bundle a locked `uv` environment into a self-contained, offline-installable directory.
-The output includes pinned requirements, third-party wheels, locally built wheels,
-and a portable Python interpreter.
-
-What it does
-------------
-- Exports a `requirements.txt` from your `uv` lock file.
-- Downloads third-party wheels into `pack/wheels/`.
-- Builds local workspace packages into `pack/vendor/`.
-- Downloads a python-build-standalone archive into `pack/python/` (unless `--system`).
-- Writes `unpack.sh`, `unpack.ps1`, and `unpack.cmd` to unpack the resulting venv offline.
-
-Install
--------
-
-Install `uv-pack` as a dev-dependency or as a uv tool.
-
-```bash
-uv add --dev uv-pack
-# or install as a tool
-uv tool install uv-pack
-```
-
-Once installed, run using:
-
-```bash
-uv run uv-pack --help
-# or as a tool
-uv tool run uv-pack --help
-# or using uvx (equivalent)
-uvx uv-pack --help
-```
-
-CLI
----
-
-```bash
-uv-pack [OUTPUT_DIRECTORY (default = ./pack)]
-```
-
-Options:
-- `--uv-export`: extra args passed to `uv export`
-- `--pip-download`: extra args passed to `pip download`
-- `--uv-build-sdist`: extra args passed to `uv build` for downloaded sdists
-- `--uv-build-pkg`: extra args passed to `uv build` for local packages
-- `--no-clean`: keep the output directory instead of wiping
-- `--include-dev`: include dev dependencies
-- `--system`: skip bundling Python; require `BASE_PY` at unpack time
-
-Example
--------
-```bash
-uv-pack --include-dev
-```
-
-Output layout
--------------
-```
-pack/
-  requirements.txt
-  wheels/
-  vendor/
-  python/   # (omitted with --system)
-  unpack.sh
-  unpack.ps1
-  unpack.cmd
-  README.md
-```
-
-Unpack and install offline
---------------------------
-
-POSIX (sh/bash/zsh):
-
-```bash
-./pack/unpack.sh
-```
-
-PowerShell:
-
-```powershell
-.\pack\unpack.ps1
-```
-
-Windows cmd:
-
-```cmd
-.\pack\unpack.cmd
-```
-
-All scripts also accept `VENV_DIR`, `PY_DEST` and `BASE_PY` environment variables.
-Use `BASE_PY` when `--system` was used during packing to provide a system
-python interpreter. `VENV_DIR` (default = `.venv`) and `PY_DEST` (default = `.python`)
-can be used to customize the target python and venv diretory.
-
-Configuration
--------------
-
-`UV_PYTHON_INSTALL_MIRROR` can override the GitHub API endpoint to retrieve the
-Python releases, default is:
-<https://api.github.com/repos/astral-sh/python-build-standalone/releases/latest>.
-
-`GITHUB_TOKEN` can be used to authenticate the request to the GitHub API to
-prevent possible rate-limiting.

uv_pack-0.0.1.dist-info/RECORD

@@ -1,14 +0,0 @@
-uv_pack/__init__.py,sha256=OUGwExvybYq3ZdHgo50pu5QujQXB_ShOES6zsWn-Gr4,9264
-uv_pack/_download.py,sha256=_1W0Dp-7iH6vBUW6drwlUH7cGVMIAz2W6OFDj5dBoZY,4497
-uv_pack/_process.py,sha256=AJPbEPjBXpMOiP7VvNB7xxjhiPJDt1GREIeC_gjKQx4,1536
-uv_pack/_unpack.py,sha256=2n7gZnMwCqHKadrPR2EWQWNUjAROuIrl-FU9EoHWBf8,1024
-uv_pack/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-uv_pack/scripts/README.md,sha256=fFmzFOExIEt0NERw1rBvsi_ur1qT3I-cVCxOBTO_rrQ,1550
-uv_pack/scripts/SPEC.md,sha256=_U31gEyPEZLfrO0u4POqdJLwgAFVzsh80bFd0hXESLU,1724
-uv_pack/scripts/unpack.cmd,sha256=bzxdyYPSN6hEQfVyg0BHJFvMiEvQe7HtGH9GPQOQSVQ,1865
-uv_pack/scripts/unpack.ps1,sha256=ygQkxsIhUfum8uX3LrjAIclfi91IN98jzU-LYEyVgOA,2150
-uv_pack/scripts/unpack.sh,sha256=1cDrzcSJeEnbFM_ZLkNnrWsfBNLRtVYIAC8yiXxFLEg,1751
-uv_pack-0.0.1.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
-uv_pack-0.0.1.dist-info/entry_points.txt,sha256=vNW2L3ycXru1h_bHFxCKTtzswejxRk6UjhAd26vRLoM,42
-uv_pack-0.0.1.dist-info/METADATA,sha256=WbYGo7B0p3n7cLLyDCYpVBN5sn4S84Id63D2tENL1fc,3922
-uv_pack-0.0.1.dist-info/RECORD,,