fast-forward

CSHS-CWRA · Jul 25, 2024 · a125427 · a125427
1 parent bf3d0a3
commit a125427
Show file tree

Hide file tree

Showing 11 changed files with 34 additions and 31 deletions.
diff --git a/.cruft.json b/.cruft.json
@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/Ouranosinc/cookiecutter-pypackage",
-  "commit": "04ac01aaf65caf5aeb1a3e2b881687473e55691c",
+  "commit": "9e52dd4dcbae384ca055d1edd4aa79ec5b436ca0",
   "context": {
     "cookiecutter": {
       "full_name": "David Huard",

diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml
@@ -31,4 +31,4 @@ jobs:
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
 
       - name: Dependency Review
-        uses: actions/dependency-review-action@0c155c5e8556a497adf53f2c18edabf945ed8e70 # v4.3.2
+        uses: actions/dependency-review-action@5a2ce3f5b92ee19cbb1541a4984c76d921601d7c # v4.3.4
diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml
@@ -72,7 +72,7 @@ jobs:
       # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
       # format to the repository Actions tab.
       - name: Upload Artifact
-        uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3
+        uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b # v4.3.4
         with:
           name: SARIF file
           path: results.sarif

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -216,13 +216,14 @@ To run specific code style checks:
 
 .. code-block:: console
 
-    python -m black --check ravenpy tests
-    python -m isort --check ravenpy tests
-    python -m blackdoc --check ravenpy docs
-    python -m ruff check ravenpy tests
-    python -m flake8 ravenpy tests
-
-To get ``black``, ``isort``, ``blackdoc``, ``ruff``, and ``flake8`` (with the ``flake8-rst-docstrings`` plugin) simply install them with ``pip`` (or ``conda``) into your environment.
+    python -m black --check src/ravenpy tests
+    python -m isort --check src/ravenpy tests
+    python -m blackdoc --check src/ravenpy docs
+    python -m ruff check src/ravenpy tests
+    python -m flake8 src/ravenpy tests
+    validate-docstrings src/ravenpy/**.py
+
+To get ``black``, ``isort``, ``blackdoc``, ``ruff``, ``flake8`` (with the ``flake8-rst-docstrings`` plugin), and ``numpydoc`` (for ``validate-docstrings``), simply install them with ``pip`` (or ``conda``) into your environment.
 
 Translations
 ------------

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021, Canadian Society for Hydrological Sciences
+Copyright (c) 2020-2024 David Huard, Trevor James Smith, Christian Jauvin, Julie Mai, Ming Han
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/Makefile b/Makefile
@@ -57,7 +57,7 @@ clean-test: ## remove test and coverage artifacts
  lint/flake8: ## check style with flake8
 	python -m ruff check src/ravenpy tests
 	python -m flake8 --config=.flake8 src/ravenpy tests
-	# python -m numpydoc --validate src/ravenpy
+	validate-docstrings src/ravenpy/**.py
 
  lint/black: ## check style with black
 	python -m black --check src/ravenpy tests

diff --git a/docs/conf.py b/docs/conf.py
@@ -155,7 +155,7 @@
 language = "en"
 
 # Sphinx-intl configuration
-locale_dirs = ['locales/']
+locale_dirs = ["locales/"]
 gettext_compact = False  # optional
 
 # List of patterns, relative to source directory, that match files and
@@ -196,7 +196,9 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = list()  # "_static"
+if not os.path.exists("_static"):
+    os.makedirs("_static")
+html_static_path = ["_static"]
 
 # -- Options for HTMLHelp output ---------------------------------------
 

diff --git a/environment-dev.yml b/environment-dev.yml
@@ -45,24 +45,24 @@ dependencies:
   - xskillscore
   # Dev tools and testing
   - pip >=24.0
+  - black ==24.4.2
+  - blackdoc ==0.3.9
   - bump-my-version >=0.24.3
-  - watchdog >=4.0.0
+  - click >=8.1.7
+  - coverage >=7.5.0
+  - coveralls >=4.0.0
   - filelock
   - flake8 >=7.1.0
   - flake8-rst-docstrings >=0.3.0
   - flit >=3.9.0,<4.0
-  - tox >=4.16.0
-  - coverage >=7.5.0
-  - coveralls >=4.0.0
-  - click >=8.1.7
   - holoviews
   - hvplot
+  - isort ==5.13.2
+  - numpydoc >=1.7.0
+  - pre-commit >=3.5.0
   - pytest >=8.2.2
   - pytest-cov >=5.0.0
   - pytest-xdist >=3.2.0
-  - black ==24.4.2
-  - blackdoc ==0.3.9
-  - isort ==5.13.2
-  - pre-commit >=3.5.0
   - ruff >=0.5.0
-  # - numpydoc >=1.7.0
+  - tox >=4.16.0
+  - watchdog >=4.0.0
diff --git a/pyproject.toml b/pyproject.toml
@@ -80,7 +80,7 @@ dev = [
   "isort ==5.13.2",
   "mypy",
   "nbval",
-  # "numpydoc >=1.7.0",
+  "numpydoc >=1.7.0",
   "pip >=24.0",
   "pre-commit >=3.5.0",
   "pylint",
@@ -146,12 +146,12 @@ all = [
 ravenpy = "ravenpy.cli:main"
 
 [project.urls]
+"Changelog" = "https://ravenpy.readthedocs.io/en/latest/changelog.html"
 "Homepage" = "https://ravenpy.readthedocs.io"
-"Source" = "https://github.com/CSHS-CWRA/RavenPy"
-"Changelog" = "https://ravenpy.readthedocs.io/en/latest/history.html"
 "Issue tracker" = "https://github.com/CSHS-CWRA/RavenPy/issues"
-"About Ouranos" = "https://www.ouranos.ca/en/"
+"Source" = "https://github.com/CSHS-CWRA/RavenPy"
 "About CSHS-CWRA" = "https://cwra.org/en/"
+"About Ouranos" = "https://ouranos.ca/en/"
 
 [tool]
 

diff --git a/src/ravenpy/__init__.py b/src/ravenpy/__init__.py
@@ -3,7 +3,7 @@
 ###################################################################################
 # MIT License
 #
-# Copyright (c) 2024, David Huard
+# Copyright (c) 2020-2024 David Huard, Trevor James Smith, Christian Jauvin, Julie Mai, Ming Han
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/tox.ini b/tox.ini
@@ -4,7 +4,7 @@ envlist =
     lint
     py{39,310,311,312}-{linux,macos}
     docs
-   coveralls
+    coveralls
 equires =
     flit ~=3.9.0
     pip >=24.0
@@ -20,7 +20,7 @@ deps =
     flake8 >=7.1.0
     flake8-rst-docstrings >=0.3.0
     ruff >=0.5.0
-    ; numpydoc >=1.7.0
+    numpydoc >=1.7.0
 commands =
     make lint
 allowlist_externals =