Skip to content

Commit fa8c8d9

Browse files
authored
refactor(dependencies): introduce ecosystem group (#289)
New group ecosystem combines dfn and models (and will include the new programs API functionality) #266 . Instead of several narrowly scoped groups we now recommend just test and ecosystem. With 2.x we can drop dfn and models
1 parent 67e5b8b commit fa8c8d9

2 files changed

Lines changed: 14 additions & 4 deletions

File tree

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,10 @@ Python development tools for MODFLOW 6 and related projects.
4343

4444
Python3.10+, dependency-free by default.
4545

46-
Several optional dependency groups are available, oriented around specific use cases:
46+
Two main dependency groups are available, oriented around specific use cases:
4747

48-
- `dfn`: MF6 definition file parsing
49-
- `test`: pytest fixtures/extensions
50-
- `models`: example model access
48+
- `test`: pytest fixtures, markers, and extensions
49+
- `ecosystem`: program/model management, definition file utilities
5150

5251
## Installation
5352

pyproject.toml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,13 @@ docs = [
6969
"sphinx-rtd-theme",
7070
"myst-parser"
7171
]
72+
# deprecated
7273
dfn = [
7374
"boltons",
7475
"tomli",
7576
"tomli-w"
7677
]
78+
# deprecated
7779
models = [
7880
"boltons",
7981
"filelock",
@@ -82,6 +84,8 @@ models = [
8284
"tomli",
8385
"tomli-w"
8486
]
87+
# prefer ecosystem to dfn/models separately
88+
ecosystem = ["modflow-devtools[dfn,models]"]
8589
dev = ["modflow-devtools[lint,test,docs,dfn,models]"]
8690

8791
[dependency-groups]
@@ -115,11 +119,13 @@ docs = [
115119
"sphinx-rtd-theme",
116120
"myst-parser"
117121
]
122+
# deprecated
118123
dfn = [
119124
"boltons",
120125
"tomli",
121126
"tomli-w"
122127
]
128+
# deprecated
123129
models = [
124130
"boltons",
125131
"filelock",
@@ -128,6 +134,11 @@ models = [
128134
"tomli",
129135
"tomli-w"
130136
]
137+
# prefer ecosystem to dfn/models separately
138+
ecosystem = [
139+
{include-group = "dfn"},
140+
{include-group = "models"},
141+
]
131142
dev = [
132143
{include-group = "build"},
133144
{include-group = "lint"},

0 commit comments

Comments
 (0)