Skip to content

Commit

Permalink
Merge pull request #382 from neutrinoceros/dep/drop_isolated_extra
Browse files Browse the repository at this point in the history
DEP: drop [isolated] extra
  • Loading branch information
neutrinoceros authored Oct 26, 2024
2 parents 2169d21 + cfc2360 commit 220fa0b
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 15 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

- DEP: drop `[isolated]` extra (external tooling should handle dependency pinning)

## [5.2.1] - 2024-09-20

BUG: fix an issue where cloning to a dir with missing parents might create
Expand Down
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,12 @@ It defines a `idfx` command familly. The builtin command set (`idfx conf`, `idfx
It is recommended to install this tool at the system level, but still in isolation,
using for instance [`uv`](https://docs.astral.sh/uv/) as
```shell
$ uv tool install 'idefix-cli[isolated]'
$ uv tool install idefix-cli
```
or [`pipx`](https://pipxproject.github.io/pipx/)
```shell
$ pipx install 'idefix-cli[isolated]'
$ pipx install idefix-cli
```
(adding `[isolated]` has the effect of pinning dependencies, but is optional)

Otherwise, the most portable way to install the latest stable version is
```shell
Expand Down
7 changes: 3 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,14 @@ helper scripts.

`idefix_cli` is distributed via the Python Packaging Index (PyPI).

It is recommended to install this tool in isolation with [`pipx`](https://pipxproject.github.io/pipx/) as
It is recommended to install this tool in isolation with [`uv`](https://docs.astral.sh/uv/) as
```shell
$ pipx install "idefix_cli[isolated]"
$ uv tool install idefix-cli
```
(adding `[isolated]` has the effect of pinning dependencies)

Otherwise, the most portable way to install the latest stable version is
```shell
$ python -m pip install --user idefix_cli
$ python -m pip install --user idefix-cli
```

Note that most `idfx` commands explicitly require that the env variable `$IDEFIX_DIR` be
Expand Down
8 changes: 0 additions & 8 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,6 @@ dynamic = ["version"]
[project.license]
text = "GPL-3.0"

[project.optional-dependencies]
isolated = [
"inifix==4.2.2",
"packaging==21.0",
"termcolor==2.3.0",
"typing-extensions==4.1.0;python_version < '3.11'",
]

[project.readme]
file = "README.md"
content-type = "text/markdown"
Expand Down

0 comments on commit 220fa0b

Please sign in to comment.