mirror of https://github.com/astral-sh/uv
Enumerate workspace members in the uv crate README (#16811)
This commit is contained in:
parent
1de0cbea94
commit
ba46a448d4
|
|
@ -7,3 +7,73 @@ for more information.
|
||||||
|
|
||||||
This crate is the entry point to the uv command-line interface. The Rust API exposed here is not
|
This crate is the entry point to the uv command-line interface. The Rust API exposed here is not
|
||||||
considered public interface.
|
considered public interface.
|
||||||
|
|
||||||
|
The following uv workspace members are also available:
|
||||||
|
|
||||||
|
- [uv-auth](https://crates.io/crates/uv-auth)
|
||||||
|
- [uv-bench](https://crates.io/crates/uv-bench)
|
||||||
|
- [uv-bin-install](https://crates.io/crates/uv-bin-install)
|
||||||
|
- [uv-build](https://crates.io/crates/uv-build)
|
||||||
|
- [uv-build-backend](https://crates.io/crates/uv-build-backend)
|
||||||
|
- [uv-build-frontend](https://crates.io/crates/uv-build-frontend)
|
||||||
|
- [uv-cache](https://crates.io/crates/uv-cache)
|
||||||
|
- [uv-cache-info](https://crates.io/crates/uv-cache-info)
|
||||||
|
- [uv-cache-key](https://crates.io/crates/uv-cache-key)
|
||||||
|
- [uv-cli](https://crates.io/crates/uv-cli)
|
||||||
|
- [uv-client](https://crates.io/crates/uv-client)
|
||||||
|
- [uv-configuration](https://crates.io/crates/uv-configuration)
|
||||||
|
- [uv-console](https://crates.io/crates/uv-console)
|
||||||
|
- [uv-dev](https://crates.io/crates/uv-dev)
|
||||||
|
- [uv-dirs](https://crates.io/crates/uv-dirs)
|
||||||
|
- [uv-dispatch](https://crates.io/crates/uv-dispatch)
|
||||||
|
- [uv-distribution](https://crates.io/crates/uv-distribution)
|
||||||
|
- [uv-distribution-filename](https://crates.io/crates/uv-distribution-filename)
|
||||||
|
- [uv-distribution-types](https://crates.io/crates/uv-distribution-types)
|
||||||
|
- [uv-extract](https://crates.io/crates/uv-extract)
|
||||||
|
- [uv-flags](https://crates.io/crates/uv-flags)
|
||||||
|
- [uv-fs](https://crates.io/crates/uv-fs)
|
||||||
|
- [uv-git](https://crates.io/crates/uv-git)
|
||||||
|
- [uv-git-types](https://crates.io/crates/uv-git-types)
|
||||||
|
- [uv-globfilter](https://crates.io/crates/uv-globfilter)
|
||||||
|
- [uv-install-wheel](https://crates.io/crates/uv-install-wheel)
|
||||||
|
- [uv-installer](https://crates.io/crates/uv-installer)
|
||||||
|
- [uv-keyring](https://crates.io/crates/uv-keyring)
|
||||||
|
- [uv-logging](https://crates.io/crates/uv-logging)
|
||||||
|
- [uv-macros](https://crates.io/crates/uv-macros)
|
||||||
|
- [uv-metadata](https://crates.io/crates/uv-metadata)
|
||||||
|
- [uv-normalize](https://crates.io/crates/uv-normalize)
|
||||||
|
- [uv-once-map](https://crates.io/crates/uv-once-map)
|
||||||
|
- [uv-options-metadata](https://crates.io/crates/uv-options-metadata)
|
||||||
|
- [uv-pep440](https://crates.io/crates/uv-pep440)
|
||||||
|
- [uv-pep508](https://crates.io/crates/uv-pep508)
|
||||||
|
- [uv-performance-memory-allocator](https://crates.io/crates/uv-performance-memory-allocator)
|
||||||
|
- [uv-platform](https://crates.io/crates/uv-platform)
|
||||||
|
- [uv-platform-tags](https://crates.io/crates/uv-platform-tags)
|
||||||
|
- [uv-preview](https://crates.io/crates/uv-preview)
|
||||||
|
- [uv-publish](https://crates.io/crates/uv-publish)
|
||||||
|
- [uv-pypi-types](https://crates.io/crates/uv-pypi-types)
|
||||||
|
- [uv-python](https://crates.io/crates/uv-python)
|
||||||
|
- [uv-redacted](https://crates.io/crates/uv-redacted)
|
||||||
|
- [uv-requirements](https://crates.io/crates/uv-requirements)
|
||||||
|
- [uv-requirements-txt](https://crates.io/crates/uv-requirements-txt)
|
||||||
|
- [uv-resolver](https://crates.io/crates/uv-resolver)
|
||||||
|
- [uv-scripts](https://crates.io/crates/uv-scripts)
|
||||||
|
- [uv-settings](https://crates.io/crates/uv-settings)
|
||||||
|
- [uv-shell](https://crates.io/crates/uv-shell)
|
||||||
|
- [uv-small-str](https://crates.io/crates/uv-small-str)
|
||||||
|
- [uv-state](https://crates.io/crates/uv-state)
|
||||||
|
- [uv-static](https://crates.io/crates/uv-static)
|
||||||
|
- [uv-tool](https://crates.io/crates/uv-tool)
|
||||||
|
- [uv-torch](https://crates.io/crates/uv-torch)
|
||||||
|
- [uv-trampoline-builder](https://crates.io/crates/uv-trampoline-builder)
|
||||||
|
- [uv-types](https://crates.io/crates/uv-types)
|
||||||
|
- [uv-version](https://crates.io/crates/uv-version)
|
||||||
|
- [uv-virtualenv](https://crates.io/crates/uv-virtualenv)
|
||||||
|
- [uv-warnings](https://crates.io/crates/uv-warnings)
|
||||||
|
- [uv-workspace](https://crates.io/crates/uv-workspace)
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,66 @@
|
||||||
|
# /// 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()
|
||||||
Loading…
Reference in New Issue