Skip to content

Commit

Permalink
refactor(pyproject.toml): add dev dependency group (#2075)
Browse files Browse the repository at this point in the history
  • Loading branch information
wpbonelli committed Jan 25, 2024
1 parent ea73e0d commit b94745d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
8 changes: 4 additions & 4 deletions DEVELOPER.md
Expand Up @@ -63,9 +63,9 @@ Then install `flopy` and core dependencies from the project root:

pip install .

The `flopy` package has a number of [optional dependencies](.docs/optional_dependencies.md), as well as extra dependencies required for linting, testing, and building documentation. Extra dependencies are listed in the `test`, `lint`, `optional`, and `doc` groups under the `[project.optional-dependencies]` section in `pyproject.toml`. Core, linting, testing and optional dependencies are included in the Conda environment in `etc/environment.yml`. Only core dependencies are included in the PyPI package &mdash; to install extra dependency groups with pip, use `pip install ".[<group>]"`. For instance, to install all extra dependency groups:
The `flopy` package has a number of [optional dependencies](.docs/optional_dependencies.md), as well as extra dependencies required for linting, testing, and building documentation. Extra dependencies are listed in the `test`, `lint`, `optional`, and `doc` groups under the `[project.optional-dependencies]` section in `pyproject.toml`. Core, linting, testing and optional dependencies are included in the Conda environment in `etc/environment.yml`. Only core dependencies are included in the PyPI package &mdash; to install extra dependency groups with pip, use `pip install ".[<group>]"`. For instance, to install all development dependencies:

pip install ".[test, lint, optional, doc]"
pip install ".[dev]"

Alternatively, with Anaconda or Miniconda:

Expand Down Expand Up @@ -169,10 +169,10 @@ jupytext --from py --to ipynb path/to/notebook

Notebook scripts can be run like any other Python script. To run `.ipynb` notebooks, you will need `jupyter` installed (`jupyter` is included with the `test` optional dependency group in `pyproject.toml`). Some of the notebooks use [optional dependencies](.docs/optional_dependencies.md) as well.

To install jupyter and optional dependencies at once:
To install all development dependencies at once, including jupyter and all optional packages:

```shell
pip install ".[test, optional]"
pip install ".[dev]"
```

To start a local Jupyter notebook server, run:
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Expand Up @@ -36,6 +36,7 @@ dependencies = [
dynamic = ["version", "readme"]

[project.optional-dependencies]
dev = ["flopy[lint,test,optional,doc]"]
lint = [
"black",
"cffconvert",
Expand Down

0 comments on commit b94745d

Please sign in to comment.