Skip to content

Commit 95b2e86

Browse files
update config and doc
1 parent 712d557 commit 95b2e86

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

doc/getting-started/install.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ Then, add the ``test`` extra specification to the ``pip install`` command (**min
268268

269269
.. code-block:: shell
270270
271-
python -m pip install -e "./[test]"
271+
python -m pip install -e "./[dev]"
272272
273273
The CLIMADA Python package defines the following `extras <https://peps.python.org/pep-0508/#extras>`_:
274274

@@ -278,10 +278,10 @@ The CLIMADA Python package defines the following `extras <https://peps.python.or
278278

279279
* - Extra
280280
- Includes Dependencies...
281-
* - ``test``
282-
- for running and evaluating tests
281+
* - ``dev``
282+
- for developers, needed for running and evaluating tests and pre-commit actions
283283
* - ``doc``
284-
- for building documentation
284+
- for building the documentation files from in-source pydoc annotations
285285

286286
The developer dependencies also include `pre-commit <https://pre-commit.com/#intro>`_, which is used to install and run automated, so-called pre-commit hooks before a new commit.
287287
In order to use the hooks defined in ``.pre-commit-config.yaml``, you need to install the hooks first.

pyproject.toml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
[build-system]
2-
requires = ["setuptools>=61", "setuptools_scm"]
2+
requires = ["setuptools >= 64"]
33
build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "climada"
77
version = "6.0.2-dev"
8-
description = "CLIMADA in Python"
8+
description = "Framework for climate risk assessment and adaptation option appraisal"
99
readme = "README.md"
1010
requires-python = ">=3.10,<3.13"
11-
license = { text = "GNU Lesser General Public License v3 (GPLv3)" }
11+
license = { text = "GNU General Public License v3 (GPLv3)" }
1212
authors = [
13-
{ name = "ETH", email = "schmide@ethz.ch" }
13+
{ name = "ETH", email = "climada-info@sympa.ethz.ch" }
1414
]
1515
keywords = ["climate", "adaptation"]
1616
classifiers = [
@@ -71,13 +71,14 @@ doc = [
7171
"sphinx-design",
7272
"sphinx-mdinclude"
7373
]
74-
test = [
74+
dev = [
7575
"ipython",
7676
"mccabe>=0.6",
7777
"pylint>=3.0",
7878
"pytest",
7979
"pytest-cov",
80-
"pytest-subtests"
80+
"pytest-subtests",
81+
"pre-commit"
8182
]
8283

8384
[project.urls]

0 commit comments

Comments
 (0)