diff --git a/crates/uv-auth/README.md b/crates/uv-auth/README.md new file mode 100644 index 000000000..e5bb4b006 --- /dev/null +++ b/crates/uv-auth/README.md @@ -0,0 +1,10 @@ + + +# uv-auth + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-bench/README.md b/crates/uv-bench/README.md new file mode 100644 index 000000000..6600c4f14 --- /dev/null +++ b/crates/uv-bench/README.md @@ -0,0 +1,10 @@ + + +# uv-bench + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-bin-install/README.md b/crates/uv-bin-install/README.md new file mode 100644 index 000000000..735e1401f --- /dev/null +++ b/crates/uv-bin-install/README.md @@ -0,0 +1,10 @@ + + +# uv-bin-install + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-build-backend/README.md b/crates/uv-build-backend/README.md new file mode 100644 index 000000000..5fa6376af --- /dev/null +++ b/crates/uv-build-backend/README.md @@ -0,0 +1,10 @@ + + +# uv-build-backend + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-build-frontend/README.md b/crates/uv-build-frontend/README.md new file mode 100644 index 000000000..b0510d959 --- /dev/null +++ b/crates/uv-build-frontend/README.md @@ -0,0 +1,10 @@ + + +# uv-build-frontend + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-cache-info/README.md b/crates/uv-cache-info/README.md new file mode 100644 index 000000000..3b6585059 --- /dev/null +++ b/crates/uv-cache-info/README.md @@ -0,0 +1,10 @@ + + +# uv-cache-info + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-cache-key/README.md b/crates/uv-cache-key/README.md new file mode 100644 index 000000000..9cc406531 --- /dev/null +++ b/crates/uv-cache-key/README.md @@ -0,0 +1,10 @@ + + +# uv-cache-key + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-cache/README.md b/crates/uv-cache/README.md new file mode 100644 index 000000000..c35e8696b --- /dev/null +++ b/crates/uv-cache/README.md @@ -0,0 +1,10 @@ + + +# uv-cache + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-cli/README.md b/crates/uv-cli/README.md new file mode 100644 index 000000000..f0cb920e6 --- /dev/null +++ b/crates/uv-cli/README.md @@ -0,0 +1,10 @@ + + +# uv-cli + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-client/README.md b/crates/uv-client/README.md new file mode 100644 index 000000000..12a3e1dc7 --- /dev/null +++ b/crates/uv-client/README.md @@ -0,0 +1,10 @@ + + +# uv-client + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-configuration/README.md b/crates/uv-configuration/README.md new file mode 100644 index 000000000..5d2ac48f9 --- /dev/null +++ b/crates/uv-configuration/README.md @@ -0,0 +1,10 @@ + + +# uv-configuration + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-console/README.md b/crates/uv-console/README.md new file mode 100644 index 000000000..3b98483ab --- /dev/null +++ b/crates/uv-console/README.md @@ -0,0 +1,10 @@ + + +# uv-console + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-dev/README.md b/crates/uv-dev/README.md new file mode 100644 index 000000000..047366892 --- /dev/null +++ b/crates/uv-dev/README.md @@ -0,0 +1,10 @@ + + +# uv-dev + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-dirs/README.md b/crates/uv-dirs/README.md new file mode 100644 index 000000000..f879d4bde --- /dev/null +++ b/crates/uv-dirs/README.md @@ -0,0 +1,10 @@ + + +# uv-dirs + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-dispatch/README.md b/crates/uv-dispatch/README.md new file mode 100644 index 000000000..b00143c7f --- /dev/null +++ b/crates/uv-dispatch/README.md @@ -0,0 +1,10 @@ + + +# uv-dispatch + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-distribution-filename/README.md b/crates/uv-distribution-filename/README.md new file mode 100644 index 000000000..dd54c9345 --- /dev/null +++ b/crates/uv-distribution-filename/README.md @@ -0,0 +1,10 @@ + + +# uv-distribution-filename + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-distribution-types/README.md b/crates/uv-distribution-types/README.md new file mode 100644 index 000000000..f25316e2a --- /dev/null +++ b/crates/uv-distribution-types/README.md @@ -0,0 +1,10 @@ + + +# uv-distribution-types + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-distribution/README.md b/crates/uv-distribution/README.md new file mode 100644 index 000000000..07914e403 --- /dev/null +++ b/crates/uv-distribution/README.md @@ -0,0 +1,10 @@ + + +# uv-distribution + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-extract/README.md b/crates/uv-extract/README.md new file mode 100644 index 000000000..1e2ef64e7 --- /dev/null +++ b/crates/uv-extract/README.md @@ -0,0 +1,10 @@ + + +# uv-extract + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-flags/README.md b/crates/uv-flags/README.md new file mode 100644 index 000000000..6eea6f8ea --- /dev/null +++ b/crates/uv-flags/README.md @@ -0,0 +1,10 @@ + + +# uv-flags + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-fs/README.md b/crates/uv-fs/README.md new file mode 100644 index 000000000..920c70a62 --- /dev/null +++ b/crates/uv-fs/README.md @@ -0,0 +1,10 @@ + + +# uv-fs + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-git-types/README.md b/crates/uv-git-types/README.md new file mode 100644 index 000000000..4e8225b90 --- /dev/null +++ b/crates/uv-git-types/README.md @@ -0,0 +1,10 @@ + + +# uv-git-types + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-git/README.md b/crates/uv-git/README.md new file mode 100644 index 000000000..1f1fd16a6 --- /dev/null +++ b/crates/uv-git/README.md @@ -0,0 +1,10 @@ + + +# uv-git + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-install-wheel/README.md b/crates/uv-install-wheel/README.md new file mode 100644 index 000000000..2ddec2a83 --- /dev/null +++ b/crates/uv-install-wheel/README.md @@ -0,0 +1,10 @@ + + +# uv-install-wheel + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-installer/README.md b/crates/uv-installer/README.md new file mode 100644 index 000000000..df226aaf6 --- /dev/null +++ b/crates/uv-installer/README.md @@ -0,0 +1,10 @@ + + +# uv-installer + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-logging/README.md b/crates/uv-logging/README.md new file mode 100644 index 000000000..856b9d18c --- /dev/null +++ b/crates/uv-logging/README.md @@ -0,0 +1,10 @@ + + +# uv-logging + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-macros/README.md b/crates/uv-macros/README.md new file mode 100644 index 000000000..4ea0bf0fd --- /dev/null +++ b/crates/uv-macros/README.md @@ -0,0 +1,10 @@ + + +# uv-macros + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-metadata/README.md b/crates/uv-metadata/README.md new file mode 100644 index 000000000..d58c4a8e0 --- /dev/null +++ b/crates/uv-metadata/README.md @@ -0,0 +1,10 @@ + + +# uv-metadata + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-normalize/README.md b/crates/uv-normalize/README.md new file mode 100644 index 000000000..55e7fd833 --- /dev/null +++ b/crates/uv-normalize/README.md @@ -0,0 +1,10 @@ + + +# uv-normalize + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-once-map/README.md b/crates/uv-once-map/README.md new file mode 100644 index 000000000..d7d0261e9 --- /dev/null +++ b/crates/uv-once-map/README.md @@ -0,0 +1,10 @@ + + +# uv-once-map + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-options-metadata/README.md b/crates/uv-options-metadata/README.md new file mode 100644 index 000000000..06de3999a --- /dev/null +++ b/crates/uv-options-metadata/README.md @@ -0,0 +1,10 @@ + + +# uv-options-metadata + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-performance-memory-allocator/README.md b/crates/uv-performance-memory-allocator/README.md new file mode 100644 index 000000000..20588afe7 --- /dev/null +++ b/crates/uv-performance-memory-allocator/README.md @@ -0,0 +1,10 @@ + + +# uv-performance-memory-allocator + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-platform-tags/README.md b/crates/uv-platform-tags/README.md new file mode 100644 index 000000000..6abcc798e --- /dev/null +++ b/crates/uv-platform-tags/README.md @@ -0,0 +1,10 @@ + + +# uv-platform-tags + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-platform/README.md b/crates/uv-platform/README.md new file mode 100644 index 000000000..a2d7d96be --- /dev/null +++ b/crates/uv-platform/README.md @@ -0,0 +1,10 @@ + + +# uv-platform + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-preview/README.md b/crates/uv-preview/README.md new file mode 100644 index 000000000..6cfd43850 --- /dev/null +++ b/crates/uv-preview/README.md @@ -0,0 +1,10 @@ + + +# uv-preview + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-publish/README.md b/crates/uv-publish/README.md new file mode 100644 index 000000000..286ab95aa --- /dev/null +++ b/crates/uv-publish/README.md @@ -0,0 +1,10 @@ + + +# uv-publish + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-pypi-types/README.md b/crates/uv-pypi-types/README.md new file mode 100644 index 000000000..5147c0d92 --- /dev/null +++ b/crates/uv-pypi-types/README.md @@ -0,0 +1,10 @@ + + +# uv-pypi-types + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-python/README.md b/crates/uv-python/README.md new file mode 100644 index 000000000..98a13680b --- /dev/null +++ b/crates/uv-python/README.md @@ -0,0 +1,10 @@ + + +# uv-python + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-redacted/README.md b/crates/uv-redacted/README.md new file mode 100644 index 000000000..532bc8f30 --- /dev/null +++ b/crates/uv-redacted/README.md @@ -0,0 +1,10 @@ + + +# uv-redacted + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-requirements-txt/README.md b/crates/uv-requirements-txt/README.md new file mode 100644 index 000000000..52eb1a1be --- /dev/null +++ b/crates/uv-requirements-txt/README.md @@ -0,0 +1,10 @@ + + +# uv-requirements-txt + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-requirements/README.md b/crates/uv-requirements/README.md new file mode 100644 index 000000000..91d2fc185 --- /dev/null +++ b/crates/uv-requirements/README.md @@ -0,0 +1,10 @@ + + +# uv-requirements + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-resolver/README.md b/crates/uv-resolver/README.md new file mode 100644 index 000000000..875026d70 --- /dev/null +++ b/crates/uv-resolver/README.md @@ -0,0 +1,10 @@ + + +# uv-resolver + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-scripts/README.md b/crates/uv-scripts/README.md new file mode 100644 index 000000000..1dc04d2b9 --- /dev/null +++ b/crates/uv-scripts/README.md @@ -0,0 +1,10 @@ + + +# uv-scripts + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-settings/README.md b/crates/uv-settings/README.md new file mode 100644 index 000000000..2a0bce884 --- /dev/null +++ b/crates/uv-settings/README.md @@ -0,0 +1,10 @@ + + +# uv-settings + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-shell/README.md b/crates/uv-shell/README.md new file mode 100644 index 000000000..388db8f31 --- /dev/null +++ b/crates/uv-shell/README.md @@ -0,0 +1,10 @@ + + +# uv-shell + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-small-str/README.md b/crates/uv-small-str/README.md new file mode 100644 index 000000000..1b322f06b --- /dev/null +++ b/crates/uv-small-str/README.md @@ -0,0 +1,10 @@ + + +# uv-small-str + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-state/README.md b/crates/uv-state/README.md new file mode 100644 index 000000000..4f0dad049 --- /dev/null +++ b/crates/uv-state/README.md @@ -0,0 +1,10 @@ + + +# uv-state + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-static/README.md b/crates/uv-static/README.md new file mode 100644 index 000000000..db0558674 --- /dev/null +++ b/crates/uv-static/README.md @@ -0,0 +1,10 @@ + + +# uv-static + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-tool/README.md b/crates/uv-tool/README.md new file mode 100644 index 000000000..69228c0f6 --- /dev/null +++ b/crates/uv-tool/README.md @@ -0,0 +1,10 @@ + + +# uv-tool + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-torch/README.md b/crates/uv-torch/README.md new file mode 100644 index 000000000..33047eb3d --- /dev/null +++ b/crates/uv-torch/README.md @@ -0,0 +1,10 @@ + + +# uv-torch + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-trampoline-builder/README.md b/crates/uv-trampoline-builder/README.md new file mode 100644 index 000000000..5c32c9f16 --- /dev/null +++ b/crates/uv-trampoline-builder/README.md @@ -0,0 +1,10 @@ + + +# uv-trampoline-builder + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-types/README.md b/crates/uv-types/README.md new file mode 100644 index 000000000..64503532c --- /dev/null +++ b/crates/uv-types/README.md @@ -0,0 +1,10 @@ + + +# uv-types + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-version/README.md b/crates/uv-version/README.md new file mode 100644 index 000000000..f1042c67a --- /dev/null +++ b/crates/uv-version/README.md @@ -0,0 +1,10 @@ + + +# uv-version + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-warnings/README.md b/crates/uv-warnings/README.md new file mode 100644 index 000000000..160d4b20c --- /dev/null +++ b/crates/uv-warnings/README.md @@ -0,0 +1,10 @@ + + +# uv-warnings + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv-workspace/README.md b/crates/uv-workspace/README.md new file mode 100644 index 000000000..51113b55a --- /dev/null +++ b/crates/uv-workspace/README.md @@ -0,0 +1,10 @@ + + +# uv-workspace + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's +[crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) +for details on versioning. diff --git a/crates/uv/README.md b/crates/uv/README.md index f0c2a8f01..85a96aac9 100644 --- a/crates/uv/README.md +++ b/crates/uv/README.md @@ -1,3 +1,5 @@ + + # uv uv is a Python package and project manager. diff --git a/scripts/generate-crate-readmes.py b/scripts/generate-crate-readmes.py new file mode 100644 index 000000000..c7d4c3f22 --- /dev/null +++ b/scripts/generate-crate-readmes.py @@ -0,0 +1,123 @@ +# /// script +# requires-python = ">=3.13" +# dependencies = [] +# /// + +import json +import pathlib +import subprocess + +GENERATED_HEADER = "" + +UV_TEMPLATE = """ +{GENERATED_HEADER} + +# uv + +uv is a Python package and project manager. + +See the [documentation](https://docs.astral.sh/uv/) or [repository](https://github.com/astral-sh/uv) +for more information. + +This crate is the entry point to the uv command-line interface. The Rust API exposed here is not +considered public interface. + +The following uv workspace members are also available: + +{WORKSPACE_MEMBERS} + +uv's workspace members are considered internal and will have frequent breaking changes. + +See uv's [crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) for details on versioning. +""" + + +MEMBER_TEMPLATE = """ +{GENERATED_HEADER} + +# {name} + +This crate is an internal component of [uv](https://crates.io/uv). The Rust API exposed here is +unstable and will have frequent breaking changes. + +See uv's [crate versioning +policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) for details on +versioning. +""" + + +def main() -> None: + result = subprocess.run( + ["cargo", "metadata", "--format-version", "1"], + capture_output=True, + text=True, + check=True, + ) + content = json.loads(result.stdout) + packages = {package["id"]: package for package in content["packages"]} + + workspace_root = pathlib.Path(content["workspace_root"]) + readme_path = workspace_root / "crates" / "uv" / "README.md" + + workspace_members = [] + for workspace_member in content["workspace_members"]: + name = packages[workspace_member]["name"] + if name != "uv": + workspace_members.append(name) + + workspace_members.sort() + + members_list = "\n".join( + f"- [{name}](https://crates.io/crates/{name})" for name in workspace_members + ) + + # Generate README for the main uv crate + readme_content = UV_TEMPLATE.format( + GENERATED_HEADER=GENERATED_HEADER, WORKSPACE_MEMBERS=members_list + ) + readme_path.write_text(readme_content) + + # Track all generated README paths for formatting at the end + generated_paths = [readme_path] + + # Generate READMEs for all workspace members + for workspace_member in content["workspace_members"]: + package = packages[workspace_member] + name = package["name"] + + # Skip the main uv crate (already handled above) + if name == "uv": + continue + + # Determine the README path for this crate + manifest_path = pathlib.Path(package["manifest_path"]) + crate_dir = manifest_path.parent + member_readme_path = crate_dir / "README.md" + + # Check if README already exists + if member_readme_path.exists(): + existing_content = member_readme_path.read_text() + # Skip if it doesn't have the generated header + if not existing_content.startswith(GENERATED_HEADER): + print(f"Skipping {name}: existing README without generated header") + continue + + # Generate the README content + member_readme_content = MEMBER_TEMPLATE.format( + GENERATED_HEADER=GENERATED_HEADER, name=name + ) + member_readme_path.write_text(member_readme_content) + generated_paths.append(member_readme_path) + + print(f"Generated README for {name}") + + # Format all generated READMEs once at the end + subprocess.run( + ["npx", "prettier", "--write", "--prose-wrap", "always"] + + [str(path) for path in generated_paths], + check=True, + ) + + +if __name__ == "__main__": + main() diff --git a/scripts/generate-uv-crate-readme.py b/scripts/generate-uv-crate-readme.py deleted file mode 100644 index 18a7229d7..000000000 --- a/scripts/generate-uv-crate-readme.py +++ /dev/null @@ -1,66 +0,0 @@ -# /// script -# requires-python = ">=3.13" -# dependencies = [] -# /// - -import json -import pathlib -import subprocess - -TEMPLATE = """# uv - -uv is a Python package and project manager. - -See the [documentation](https://docs.astral.sh/uv/) or [repository](https://github.com/astral-sh/uv) -for more information. - -This crate is the entry point to the uv command-line interface. The Rust API exposed here is not -considered public interface. - -The following uv workspace members are also available: - -{WORKSPACE_MEMBERS} - -uv's workspace members are considered internal and will have frequent breaking changes. - -See uv's [crate versioning policy](https://docs.astral.sh/uv/reference/policies/versioning/#crate-versioning) for details on versioning. -""" - - -def main() -> None: - result = subprocess.run( - ["cargo", "metadata", "--format-version", "1"], - capture_output=True, - text=True, - check=True, - ) - content = json.loads(result.stdout) - packages = {package["id"]: package for package in content["packages"]} - - workspace_root = pathlib.Path(content["workspace_root"]) - readme_path = workspace_root / "crates" / "uv" / "README.md" - - workspace_members = [] - for workspace_member in content["workspace_members"]: - name = packages[workspace_member]["name"] - if name != "uv": - workspace_members.append(name) - - workspace_members.sort() - - members_list = "\n".join( - f"- [{name}](https://crates.io/crates/{name})" for name in workspace_members - ) - - readme_content = TEMPLATE.format(WORKSPACE_MEMBERS=members_list) - - readme_path.write_text(readme_content) - - subprocess.run( - ["npx", "prettier", "--write", "--prose-wrap", "always", str(readme_path)], - check=True, - ) - - -if __name__ == "__main__": - main()