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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
import os
import pathlib
import shutil
from glob import glob
import nox
nox.options.reuse_existing_virtualenvs = False
# Sphinx output and source directories
BUILD_DIR = "_build"
OUTPUT_DIR = pathlib.Path(BUILD_DIR, "html")
SOURCE_DIR = pathlib.Path("docs")
# Sphinx build commands
SPHINX_BUILD = "sphinx-build"
SPHINX_AUTO_BUILD = "sphinx-autobuild"
# Sphinx parameters used to build the guide
BUILD_PARAMETERS = ["-b", "html"]
# Sphinx parameters used to test the build of the guide
TEST_PARAMETERS = ["-W", "--keep-going", "-E", "-a"]
# Sphinx-autobuild ignore and include parameters
AUTOBUILD_IGNORE = [
"_build",
".nox",
"build_assets",
"tmp",
]
AUTOBUILD_INCLUDE = [pathlib.Path("_static", "pyos.css")]
# Build docs
build_command = ["-b", "html", "docs/", "docs/_build/html"]
@nox.session(name="docs-test", python="3.11")
def docs_test(session):
"""A session that builds the docs statically and returns any errors that
it finds."""
session.install(".[docs]")
session.run(
SPHINX_BUILD,
*BUILD_PARAMETERS,
*TEST_PARAMETERS,
SOURCE_DIR,
OUTPUT_DIR,
*session.posargs,
)
@nox.session(name="docs", python="3.11")
def docs(session):
session.install(".[docs]")
cmd = ["sphinx-build"]
cmd.extend(build_command + session.posargs)
session.run(*cmd)
@nox.session(name="docs-live", python="3.11")
def docs_live(session):
session.install(".[docs]")
AUTOBUILD_IGNORE = [
"_build",
"build_assets",
"tmp",
]
cmd = ["sphinx-autobuild"]
for folder in AUTOBUILD_IGNORE:
cmd.extend(["--ignore", f"*/{folder}/*"])
cmd.extend(build_command + session.posargs)
session.run(*cmd)
####### RUN TESTS ########
# Use this for venv envs nox -s test
@nox.session(python=["3.10", "3.11", "3.12", "3.13"])
def tests(session):
"""Install requirements in a venv and run tests."""
session.install(".[tests]")
session.run(
"pytest",
"--cov=src/stravalib",
"--cov-report=xml:coverage.xml",
"--cov-report=term",
"src/stravalib/tests/unit/",
"src/stravalib/tests/integration/",
)
# Use this for venv envs nox -s mypy
@nox.session(python="3.11")
def mypy(session):
session.install(".[lint]")
session.run(
"mypy",
)
@nox.session(name="docs-clean")
def clean_docs(session):
"""
Clean out the docs directory used in the
live build.
"""
dirs_to_clean = [
pathlib.Path("docs", "_build"),
pathlib.Path("docs", "reference", "api"),
]
for dir_path in dirs_to_clean:
print(f"Cleaning directory: {dir_path}")
dir_contents = dir_path.glob("*")
for content in dir_contents:
print(f"cleaning content from the {dir_path}")
if content.is_dir():
shutil.rmtree(content)
else:
os.remove(content)
# Clean the API doc stubs (autogenerated)
api_path = pathlib.Path("docs", "reference", "api")
api_contents = api_path.glob("*")
for content in api_contents:
print(f"cleaning out API stub docs {api_path}")
os.remove(content)
@nox.session()
def build(session):
"""Build the package's SDist and wheel using PyPA build and
setuptools / setuptools_scm"""
session.install(".[build]")
session.run("python", "-m", "build")
@nox.session()
def install_wheel(session):
"""If you have several wheels in your dist/ directory this will
try to install each one. so be sure to clean things out before
running."""
wheel_files = glob(os.path.join("dist", "*.whl"))
print(wheel_files)
if wheel_files:
most_recent_wheel = max(wheel_files, key=os.path.getmtime)
print("Installing:", most_recent_wheel)
session.install(most_recent_wheel)
else:
print("No wheel files found matching the pattern: *.whl")
@nox.session()
def clean_build(session):
"""Clean out the dist/ directory and also clean out other remnant
files such as .coverage, etc."""
dirs_remove = [
"__pycache__",
".mypy_cache",
"build",
"dist",
]
files_remove = [
"*.pyc",
"*.orig",
".coverage",
"MANIFEST",
"*.egg-info",
".cache",
".pytest_cache",
"src/stravalib/_version_generated.py",
]
for pattern in files_remove:
matches = glob(pattern, recursive=True)
print("searching for", matches)
for match in matches:
if os.path.isfile(match):
os.remove(match)
print(f"Removed file: {match}")
for a_dir in dirs_remove:
if os.path.isdir(a_dir):
shutil.rmtree(a_dir)
print(f"Removed directory: {a_dir}")
|
