Metadata-Version: 2.4
Name: uvault
Version: 0.3.0
Summary: Development and vaulting workflow for uv VCS dependencies.
Project-URL: Homepage, https://github.com/petrus-v/uvault
Project-URL: Repository, https://github.com/petrus-v/uvault
Project-URL: Documentation, https://github.com/petrus-v/uvault/tree/main/docs
Author-email: Pierre Verkest <pierre@verkest.fr>
License: MIT License
        
        Copyright (c) 2026 Pierre Verkest
        
        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.
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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.14
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: diskcache>=5.6.3
Requires-Dist: tomlkit>=0.15.0
Description-Content-Type: text/markdown

# uvault

[![PyPI version](https://badge.fury.io/py/uvault.svg)](https://badge.fury.io/py/uvault)
[![CI](https://github.com/petrus-v/uvault/actions/workflows/ci.yml/badge.svg)](https://github.com/petrus-v/uvault/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/petrus-v/uvault/branch/main/graph/badge.svg)](https://codecov.io/gh/petrus-v/uvault)

Development and vaulting workflow for [uv](https://github.com/astral-sh/uv) VCS dependencies.

Secure your Python projects against deleted or force-pushed upstream commits. `uvault` automatically vaults transient VCS references (like GitHub PRs) into your organization's own repositories, while allowing developers to instantly switch dependencies into local editable mode—fully integrated with `pyproject.toml` and `uv`.

## Key Features

1. **Vaulting of Commits**: Never lose code again! Upstream pull requests and branches can be force-pushed or deleted. `uvault` fetches the exact commits your project depends on and pushes them as immutable tags to your own organization's vault repository.
2. **Easy Local Development**: Switch any VCS dependency to local "editable" mode in seconds. `uvault develop` clones the package locally and seamlessly configures `uv` to use your local copy so you can test changes and contribute back.

## Documentation

The complete documentation is available in the `docs/` folder:

* [Quickstart & Key Features](https://github.com/petrus-v/uvault/blob/main/docs/index.md) - Learn what `uvault` is and how to get started quickly.
* [How-To Guides](https://github.com/petrus-v/uvault/blob/main/docs/how-to.md) - Step-by-step guides for installing and using `uvault` in your day-to-day workflow.
* [CLI & Configuration Reference](https://github.com/petrus-v/uvault/blob/main/docs/reference.md) - Detailed information on `pyproject.toml` configuration (`[tool.uvault]`) and all CLI commands (`sync`, `add`, `develop`).
