https://github.com/cvxgrp/cvxcli

Example cli using fire, uv and uvx
https://github.com/cvxgrp/cvxcli

cli command-line-tool uv uvx

Last synced: 3 months ago
JSON representation

Example cli using fire, uv and uvx

• Host: GitHub
• URL: https://github.com/cvxgrp/cvxcli
• Owner: cvxgrp
• License: apache-2.0
• Created: 2023-07-31T16:29:13.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-02-04T04:46:13.000Z (8 months ago)
• Last Synced: 2025-03-27T05:34:45.057Z (7 months ago)
• Topics: cli, command-line-tool, uv, uvx
• Language: Python
• Homepage:
• Size: 8.1 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# cvxcli

[![PyPI version](https://badge.fury.io/py/cvxcli.svg)](https://badge.fury.io/py/cvxcli)

[![Apache 2.0 License](https://img.shields.io/badge/License-APACHEv2-brightgreen.svg)](https://github.com/cvxgrp/cvxcli/blob/master/LICENSE)

[![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/cvxcli/badge.png?branch=main)](https://coveralls.io/github/cvxgrp/cvxcli?branch=main)

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/cvxgrp/cvxcli)

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

## Install uvx

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 uv/uvx please refer to the [uvx documentation](https://docs.astral.sh/uv/getting-started/installation/).

## 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.

cvxcli is not exactly a package you should use as a dependency in your own code.

cvxcli is the home for two apps that are meant to be used from the command line.

So please run via uvx

```bash

uvx --from cvxcli weather

```

This command will create a temporary virtual environment for cvxcli

and install the package into that environment.

Please note that you **do need uvx** to be installed on your machine.