Skip to content

Commit

Permalink
docs: move migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
fredrikaverpil committed Jan 5, 2025
1 parent 89f6ca2 commit 912ec7a
Showing 1 changed file with 42 additions and 42 deletions.
84 changes: 42 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,48 +5,6 @@

Identify unused dependencies and avoid a bloated virtual environment.

## 🌀 Migration guide: creosote 2.x to 3.x

<details>
<summary>Expand me to read the guide.</summary>

<br>Creosote was updated to 3.0.0 because the way arguments were supplied has
now changed. This also brings `pyproject.toml` configuration support.

### Argument name change

The argument naming has changed:

| 2.x argument name | 3.x argument name |
| ----------------- | ----------------- |
| `--exclude-deps` | `--exclude-dep` |
| `--paths` | `--path` |
| `--sections` | `--section` |

### Multiple argument values

With creosote 2.x, you were able to provide multiple values following some
arguments, example:

```bash
creosote -p file1.py file2.py
```

With creosote 3.x, you must now provide multiple arguments as a key/value pair:

```bash
creosote -p file1.py -p file2.py
```

This new creosote 3.x behavior applies to the following 3.x CLI arguments:

- `--venv`
- `--exclude-dep`
- `-p` or `--path`
- `-s` or `--section`

</details>

## ⚡️ Quickstart

Install creosote in separate virtual environment, using e.g.
Expand Down Expand Up @@ -274,6 +232,48 @@ Because it makes me happy to see this tool can help others! 🥰
- [Creosote - Identify unused dependencies and avoid a bloated virtual environment](https://www.reddit.com/r/Python/comments/11n717z/creosote_identify_unused_dependencies_and_avoid_a/)
— Reddit
## 🌀 Migration guide: creosote 2.x to 3.x
<details>
<summary>Expand me to read the guide.</summary>
<br>Creosote was updated to 3.0.0 because the way arguments were supplied has
now changed. This also brings `pyproject.toml` configuration support.

### Argument name change

The argument naming has changed:

| 2.x argument name | 3.x argument name |
| ----------------- | ----------------- |
| `--exclude-deps` | `--exclude-dep` |
| `--paths` | `--path` |
| `--sections` | `--section` |

### Multiple argument values

With creosote 2.x, you were able to provide multiple values following some
arguments, example:

```bash
creosote -p file1.py file2.py
```

With creosote 3.x, you must now provide multiple arguments as a key/value pair:

```bash
creosote -p file1.py -p file2.py
```

This new creosote 3.x behavior applies to the following 3.x CLI arguments:

- `--venv`
- `--exclude-dep`
- `-p` or `--path`
- `-s` or `--section`

</details>

## 👩‍🔬 Development/debugging info

### Install in-development builds
Expand Down

0 comments on commit 912ec7a

Please sign in to comment.