Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tschm authored Dec 26, 2024
1 parent df79a7d commit 307be4b
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
[![Downloads](https://static.pepy.tech/personalized-badge/cvxcli?period=month&units=international_system&left_color=black&right_color=orange&left_text=PyPI%20downloads%20per%20month)](https://pepy.tech/project/cvxcli)
[![Coverage Status](https://coveralls.io/repos/github/cvxgrp/simulator/badge.png?branch=main)](https://coveralls.io/github/cvxgrp/cvxcli?branch=main)

We demonstrate how to deploy to simple command line apps using pipx.
We demonstrate how to deploy to simple command line apps using uvx.

## Install pipx

The current way to deploy apps is to use [pipx](https://pypa.github.io/pipx/).
The tool creates a virtual environment for each app.
The current way to deploy apps is to use [uvx](https://docs.astral.sh/uv/guides/tools/).
The tool creates a temporary virtual environment for each app.

For the installation of pipx please refer to the [pipx documentation](https://pypa.github.io/pipx/installation/).
For the installation of uv/uvx please refer to the [uvx documentation](https://docs.astral.sh/uv/getting-started/installation/).

## Install cvxcli with pipx
## Install cvxcli with uvx

cvxcli has been deployed to PyPI like any other Python package. It could be
installed via pip but we advise against that.
Expand All @@ -24,7 +24,7 @@ cvxcli is the home for two apps that are meant to be used from the command line.
So please install via pipx

```bash
pipx install cvxcli
uvx install cvxcli
```

This command will create a virtual environment for cvxcli and install the package
Expand Down

0 comments on commit 307be4b

Please sign in to comment.