Skip to content

Commit

Permalink
Fix description
Browse files Browse the repository at this point in the history
Signed-off-by: Bernát Gábor <[email protected]>
  • Loading branch information
gaborbernat committed Feb 16, 2024
1 parent 91f2327 commit e81b517
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,12 @@
[![check](https://github.com/tox-dev/tox-uv/actions/workflows/check.yml/badge.svg)](https://github.com/tox-dev/tox-uv/actions/workflows/check.yml)
[![Downloads](https://static.pepy.tech/badge/tox-uv/month)](https://pepy.tech/project/tox-uv)

**tox-uv** is a tox plugin which replaces pip with uv in tox.
**tox-uv** is a tox plugin which replaces virtualenv and pip with uv your tox environments.
Note that you will get both the benefits (performance) or downsides (bugs) of uv.

Simply install `tox-uv` into the environment your tox is installed and will replace virtualenv and pip in the tox
run environments with uv.

Note: currently we haven't implemented uv support for packaging environments, so only your run tox environments will
use uv. Also, uv does not have at the moment a `pip freeze/list` like feature, so we still install pip into the
environment to perform this operation via pip.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ requires = [

[project]
name = "tox-uv"
description = "Integration of uv into GitHub Actions."
description = "Integration of uv with tox."
readme = "README.md"
keywords = [
"environments",
Expand Down

0 comments on commit e81b517

Please sign in to comment.