| Name | uvx JSON |
| Version |
2.5.1
JSON |
| download |
| home_page | None |
| Summary | uvx: pipx for uv (🦀) |
| upload_time | 2024-07-20 13:12:42 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Deprecation Warning
[https://pypi.org/project/uvenv](https://pypi.org/project/uvenv)
> **Note:** The tool previously named `uvx` is now `uvenv` due to a naming collision with a new `uv` command. The new name
> better reflects its purpose, combining `uv` with `venv`.
> You can run `uvenv self migrate` to move your environments and installed commands from `uvx` to `uvenv`.
---
---
---
# uvx: pipx for uv
Inspired by:
- [pipx](https://github.com/pypa/pipx)
- [uv](https://github.com/astral-sh/uv)
## Installation
1. Install via pip (or alternatives):
```bash
pip install uvx # or `uv`, `pipx`
```
2. Optional (for bash users):
```bash
uvx setup
```
This installs the following features:
- Ensures `~/.local/bin/` is added to your PATH, so commands can be found (unless `--skip-ensurepath`). Can also be
activated via `uvx ensurepath`
- Enables tab completion for `uvx` (unless `--skip-completions`). Can also be enabled via `uvx completions --install`.
- Enables `uvx activate` (unless `--skip-activate`) to activate uvx-managed virtualenvs from your shell
## Usage
```bash
uvx
```
Run `uvx` without any arguments to see all possible subcommands.
## Platform Considerations
- **Rust-Powered Performance (uvx 2.0):** Starting from version 2.0, `uvx` leverages Rust for improved performance and
compatibility with `uv`.
- **Prebuilt Binaries:** Currently, prebuilt binaries are available for x86_64 (amd64) and aarch64 (ARM64) on Linux.
- **Other Platforms:** If you're on a different platform, you can still use `uvx 1.x`, which is written in pure Python.
Find it at [robinvandernoord/uvx](https://github.com/robinvandernoord/uvx).
- Alternatively, you can **Compile for Your Platform**:
- Install the Rust toolchain:
```bash
curl https://sh.rustup.rs -sSf | sh
```
- Clone the `uvx2` repo and navigate to it:
```bash
git clone https://github.com/robinvandernoord/uvx2.git
cd uvx2
```
- Set up a virtual environment (choose Python or uv):
```bash
python -m venv venv # or `uv venv venv --seed`
source venv/bin/activate
```
- Install Maturin (Python with Rust package builder):
```bash
pip install maturin # or `uv pip install maturin`
```
- Compile and install the `uvx` binary:
```bash
maturin develop
```
- Now you can use `uvx`:
```bash
./venv/bin/uvx
```
For additional details on building and distribution, refer to [maturin](https://www.maturin.rs/distribution)
documentation.
## License
`uvx` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
## Changelog
See `CHANGELOG.md` [on GitHub](https://github.com/robinvandernoord/uvx2/blob/master/CHANGELOG.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "uvx",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Robin van der Noord <robinvandernoord@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/81/21/f0a4fd5353be1dc9f615596214a9765d650e4c04d3ee3b713fb978f7c1f9/uvx-2.5.1.tar.gz",
"platform": null,
"description": "\n# Deprecation Warning\n\n[https://pypi.org/project/uvenv](https://pypi.org/project/uvenv)\n\n> **Note:** The tool previously named `uvx` is now `uvenv` due to a naming collision with a new `uv` command. The new name\n> better reflects its purpose, combining `uv` with `venv`. \n> You can run `uvenv self migrate` to move your environments and installed commands from `uvx` to `uvenv`.\n\n\n---\n\n---\n\n---\n\n# uvx: pipx for uv\n\nInspired by:\n\n- [pipx](https://github.com/pypa/pipx)\n- [uv](https://github.com/astral-sh/uv)\n\n## Installation\n\n1. Install via pip (or alternatives):\n ```bash\n pip install uvx # or `uv`, `pipx`\n ```\n\n2. Optional (for bash users):\n ```bash\n uvx setup\n ```\n\n This installs the following features:\n\n- Ensures `~/.local/bin/` is added to your PATH, so commands can be found (unless `--skip-ensurepath`). Can also be\n activated via `uvx ensurepath`\n- Enables tab completion for `uvx` (unless `--skip-completions`). Can also be enabled via `uvx completions --install`.\n- Enables `uvx activate` (unless `--skip-activate`) to activate uvx-managed virtualenvs from your shell\n\n## Usage\n\n```bash\nuvx\n```\n\nRun `uvx` without any arguments to see all possible subcommands.\n\n## Platform Considerations\n\n- **Rust-Powered Performance (uvx 2.0):** Starting from version 2.0, `uvx` leverages Rust for improved performance and\n compatibility with `uv`.\n- **Prebuilt Binaries:** Currently, prebuilt binaries are available for x86_64 (amd64) and aarch64 (ARM64) on Linux.\n- **Other Platforms:** If you're on a different platform, you can still use `uvx 1.x`, which is written in pure Python.\n Find it at [robinvandernoord/uvx](https://github.com/robinvandernoord/uvx).\n- Alternatively, you can **Compile for Your Platform**:\n - Install the Rust toolchain:\n ```bash\n curl https://sh.rustup.rs -sSf | sh\n ```\n - Clone the `uvx2` repo and navigate to it:\n ```bash\n git clone https://github.com/robinvandernoord/uvx2.git\n cd uvx2\n ```\n - Set up a virtual environment (choose Python or uv):\n ```bash\n python -m venv venv # or `uv venv venv --seed`\n source venv/bin/activate\n ```\n - Install Maturin (Python with Rust package builder):\n ```bash\n pip install maturin # or `uv pip install maturin`\n ```\n - Compile and install the `uvx` binary:\n ```bash\n maturin develop\n ```\n - Now you can use `uvx`:\n ```bash\n ./venv/bin/uvx\n ```\n\nFor additional details on building and distribution, refer to [maturin](https://www.maturin.rs/distribution)\ndocumentation.\n\n## License\n\n`uvx` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n\n## Changelog\n\nSee `CHANGELOG.md` [on GitHub](https://github.com/robinvandernoord/uvx2/blob/master/CHANGELOG.md)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "uvx: pipx for uv (\ud83e\udd80)",
"version": "2.5.1",
"project_urls": {
"Source Code": "https://github.com/robinvandernoord/uvx2"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5fe4f6235134e3e553007e4dd4ac0f7231419bf9a58b30b1504619d19e5b2347",
"md5": "df4a7dfe9951a399c1011ecc9fb0ecef",
"sha256": "5713140392cf2db3fcad680bc10afb9c0a16d7a8ac793f3b769aa13422ccd9d8"
},
"downloads": -1,
"filename": "uvx-2.5.1-py3-none-manylinux_2_34_aarch64.whl",
"has_sig": false,
"md5_digest": "df4a7dfe9951a399c1011ecc9fb0ecef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5427622,
"upload_time": "2024-07-20T13:11:55",
"upload_time_iso_8601": "2024-07-20T13:11:55.721338Z",
"url": "https://files.pythonhosted.org/packages/5f/e4/f6235134e3e553007e4dd4ac0f7231419bf9a58b30b1504619d19e5b2347/uvx-2.5.1-py3-none-manylinux_2_34_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "554d4201b9943dc619faa9fcdc3022eaf375bca278671932e91a690f260a9568",
"md5": "16a752ad6476d5283dd04d9369db214d",
"sha256": "117fc1eb097062d3c189b5c546140114c032e8b9e68b0a0fead6a2bb30c1d64d"
},
"downloads": -1,
"filename": "uvx-2.5.1-py3-none-manylinux_2_34_x86_64.whl",
"has_sig": false,
"md5_digest": "16a752ad6476d5283dd04d9369db214d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5439911,
"upload_time": "2024-07-20T13:12:40",
"upload_time_iso_8601": "2024-07-20T13:12:40.229420Z",
"url": "https://files.pythonhosted.org/packages/55/4d/4201b9943dc619faa9fcdc3022eaf375bca278671932e91a690f260a9568/uvx-2.5.1-py3-none-manylinux_2_34_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8121f0a4fd5353be1dc9f615596214a9765d650e4c04d3ee3b713fb978f7c1f9",
"md5": "f0d71257e40053cd813ad61d73be859c",
"sha256": "8c940376cc5b17b878c5e642674cc8d9ccae6a6b9cfb340f551acb010551f3c4"
},
"downloads": -1,
"filename": "uvx-2.5.1.tar.gz",
"has_sig": false,
"md5_digest": "f0d71257e40053cd813ad61d73be859c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 56006,
"upload_time": "2024-07-20T13:12:42",
"upload_time_iso_8601": "2024-07-20T13:12:42.958201Z",
"url": "https://files.pythonhosted.org/packages/81/21/f0a4fd5353be1dc9f615596214a9765d650e4c04d3ee3b713fb978f7c1f9/uvx-2.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-20 13:12:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "robinvandernoord",
"github_project": "uvx2",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "uvx"
}
