Repository navigation
Expand file tree
/
Copy pathnoxfile.py
More file actions
119 lines (93 loc) · 3.45 KB
/
Copy pathnoxfile.py
File metadata and controls
119 lines (93 loc) · 3.45 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
from __future__ import annotations
import argparse
import shutil
from pathlib import Path
import nox
DIR = Path(__file__).parent.resolve()
nox.needs_version = ">=2024.3.2"
nox.options.sessions = ["lint", "pylint", "tests"]
# All sessions use conda backend — the package ships via conda only.
nox.options.default_venv_backend = "conda"
# ---------------------------------------------------------------------------
# Conda deps — keep in sync with [tool.conda] in pyproject.toml
# Only packages that lack pre-built wheels on PyPI.
# ---------------------------------------------------------------------------
CONDA_DEPS = [
"earthengine-api",
"llvmlite",
"numba",
"dask",
"netCDF4",
"xesmf",
]
def _install_via_conda(session: nox.Session) -> None:
"""Install conda-only deps into the session environment."""
session.conda_install("--channel=conda-forge", "--yes", *CONDA_DEPS)
# ---------------------------------------------------------------------------
# Sessions
# ---------------------------------------------------------------------------
@nox.session # type: ignore[no-untyped-decorator]
def lint(session: nox.Session) -> None:
"""Run the linter (pre-commit hooks)."""
session.install("pre-commit")
session.run(
"pre-commit", "run", "--all-files", "--show-diff-on-failure", *session.posargs
)
@nox.session # type: ignore[no-untyped-decorator]
def pylint(session: nox.Session) -> None:
"""Run PyLint."""
session.install("-e", ".")
session.install("pylint>=3.2")
session.run("pylint", "downclim", *session.posargs)
@nox.session # type: ignore[no-untyped-decorator]
def tests(session: nox.Session) -> None:
"""Run the unit and regular tests."""
_install_via_conda(session)
session.install("-e", ".[test]")
session.run("pytest", *session.posargs)
@nox.session(reuse_venv=True) # type: ignore[no-untyped-decorator]
def docs(session: nox.Session) -> None:
"""Build the docs. Pass --non-interactive to avoid serving. First positional argument is the target directory."""
parser = argparse.ArgumentParser()
parser.add_argument(
"-b", dest="builder", default="html", help="Build target (default: html)"
)
parser.add_argument("output", nargs="?", help="Output directory")
args, posargs = parser.parse_known_args(session.posargs)
serve = args.builder == "html" and session.interactive
_install_via_conda(session)
session.install("-e", ".[docs]")
session.install("sphinx-autobuild")
shared_args = (
"-n",
"-T",
f"-b={args.builder}",
"docs",
args.output or f"docs/_build/{args.builder}",
*posargs,
)
if serve:
session.run("sphinx-autobuild", "--open-browser", *shared_args)
else:
session.run("sphinx-build", "--keep-going", *shared_args)
@nox.session # type: ignore[no-untyped-decorator]
def build_api_docs(session: nox.Session) -> None:
"""Build (regenerate) API docs."""
session.install("sphinx")
session.run(
"sphinx-apidoc",
"-o",
"docs/api_reference/",
"--module-first",
"--no-toc",
"--force",
"src/downclim",
)
@nox.session # type: ignore[no-untyped-decorator]
def build(session: nox.Session) -> None:
"""Build an SDist and wheel."""
build_path = DIR.joinpath("build")
if build_path.exists():
shutil.rmtree(build_path)
session.install("build")
session.run("python", "-m", "build")