Skip to content

Commit

Permalink
feat(easy install option):
Browse files Browse the repository at this point in the history
  • Loading branch information
stvnksslr committed Nov 20, 2024
1 parent 4c2ad18 commit 90f1a05
Showing 1 changed file with 21 additions and 9 deletions.
30 changes: 21 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,57 +34,69 @@ Before you begin, ensure you have the following installed:

## Installation

Install to .local/bin

```sh
curl https://uv-migrator.stvnksslr.com/install.sh | bash
```

Install via Cargo

```sh
cargo install uv-migrator
```

The compiled binary will be available in the `target/release` directory.

## Supported Package Managers

* poetry
* pip (requirements.txt)
- poetry
- pip (requirements.txt)

## In Progress

* pdm
* hatch
* pipenv
* Open Issues for more!
- pdm
- hatch
- pipenv
- Open Issues for more!

## Usage

Run the UV Migrator with the path to your existing project directory:

```
```sh
uv-migrator path/to/your/project
```

or

```
```sh
1. cd /to/project
2. uv-migrator .
```

### Additional Options

- `--import-global-pip-conf`: Import extra index URLs from `~/.pip/pip.conf`

```bash
uv-migrator path/to/your/project --import-global-pip-conf
```

- `--import-index`: Specify additional index URLs to import (can be used multiple times)

```bash
uv-migrator path/to/your/project --import-index https://custom.pypi.org/simple/
```

- `--help`: Display comprehensive help information

```bash
uv-migrator --help
```

- `--self-update`: Update UV Migrator to the latest version

```bash
uv-migrator --self-update
```
```

0 comments on commit 90f1a05

Please sign in to comment.