From 912ec7a746b6b83e7a19976302e7a13ce3e5b32b Mon Sep 17 00:00:00 2001 From: Fredrik Averpil Date: Sun, 5 Jan 2025 21:37:07 +0100 Subject: [PATCH] docs: move migration guide --- README.md | 84 +++++++++++++++++++++++++++---------------------------- 1 file changed, 42 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index a041e2c..c57f67a 100644 --- a/README.md +++ b/README.md @@ -5,48 +5,6 @@ Identify unused dependencies and avoid a bloated virtual environment. -## 🌀 Migration guide: creosote 2.x to 3.x - -
-Expand me to read the guide. - -
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` - -
- ## ⚡️ Quickstart Install creosote in separate virtual environment, using e.g. @@ -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 + +
+Expand me to read the guide. + +
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` + +
+ ## 👩‍🔬 Development/debugging info ### Install in-development builds