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
|
"""Development automation
"""
import datetime
import glob
import os
import tempfile
import nox
PACKAGE_NAME = "sphinx_inline_tabs"
nox.options.sessions = ["lint", "test"]
#
# Helpers
#
def _install_this_project_with_flit(session, *, extras=None, editable=False):
session.install("flit")
args = []
if extras:
args.append("--extras")
args.append(",".join(extras))
if editable:
args.append("--pth-file" if os.name == "nt" else "--symlink")
session.run("flit", "install", "--deps=production", *args, silent=True)
#
# Development Sessions
#
@nox.session(name="docs-live")
def docs_live(session):
if session.posargs:
docs_dir = session.posargs[0]
additional_dependencies = session.posargs[1:]
else:
docs_dir = "docs/"
additional_dependencies = ()
_install_this_project_with_flit(session, extras=["doc"], editable=True)
session.install("sphinx-autobuild", *additional_dependencies)
with tempfile.TemporaryDirectory() as destination:
session.run(
"sphinx-autobuild",
# for sphinx-autobuild
"--port=0",
"--watch=src/",
"--open-browser",
# for sphinx
"-b=dirhtml",
"-a",
docs_dir,
destination,
)
@nox.session
def docs(session):
_install_this_project_with_flit(session, extras=["doc"], editable=False)
# Generate documentation into `build/docs`
session.run("sphinx-build", "-b", "dirhtml", "-v", "docs/", "build/docs")
@nox.session
def lint(session):
session.install("pre-commit")
args = list(session.posargs)
args.append("--all-files")
if "CI" in os.environ:
args.append("--show-diff-on-failure")
session.run("pre-commit", "run", "--all-files", *args)
@nox.session
def test(session):
_install_this_project_with_flit(session, extras=["test"])
args = session.posargs or ["-n", "auto", "--cov", PACKAGE_NAME]
session.run("pytest", *args)
def get_release_versions(version_file):
marker = "__version__ = "
with open(version_file) as f:
for line in f:
if line.startswith(marker):
version = line[len(marker) + 1 : -2]
last_release_date, last_release_number_str = version.split(".dev")
last_release_number = int(last_release_number_str)
break
else:
raise RuntimeError("Could not find current version.")
today = datetime.date.today()
today_date = today.strftime("%Y.%m.%d")
if last_release_date.startswith(today_date):
release_version = today_date
else:
release_version = today.strftime(f"%Y.%m.%d.{last_release_number}")
next_version = today.strftime(f"%Y.%m.%d.dev{last_release_number+1}")
return release_version, next_version
@nox.session
def release(session):
version_file = f"src/{PACKAGE_NAME}/__init__.py"
allowed_upstreams = [
f"git@github.com:pradyunsg/{PACKAGE_NAME.replace('_', '-')}.git"
]
release_version, next_version = get_release_versions(version_file)
session.install("flit", "twine", "release-helper")
# Sanity Checks
session.run("release-helper", "version-check-validity", release_version)
session.run("release-helper", "version-check-validity", next_version)
session.run("release-helper", "directory-check-empty", "dist")
session.run("release-helper", "git-check-branch", "main")
session.run("release-helper", "git-check-clean")
session.run("release-helper", "git-check-tag", release_version, "--does-not-exist")
session.run("release-helper", "git-check-remote", "origin", *allowed_upstreams)
# Prepare release commit
session.run("release-helper", "version-bump", version_file, release_version)
session.run("git", "add", version_file, external=True)
session.run(
"git", "commit", "-m", f"Prepare release: {release_version}", external=True
)
# Build the package
session.run("flit", "build")
session.run("twine", "check", *glob.glob("dist/*"))
# Tag the commit
session.run(
# fmt: off
"git", "tag", release_version, "-m", f"Release {release_version}", "-s",
external=True,
# fmt: on
)
# Prepare back-to-development commit
session.run("release-helper", "version-bump", version_file, next_version)
session.run("git", "add", version_file, external=True)
session.run("git", "commit", "-m", "Back to development", external=True)
# Push the commits and tag.
session.run("git", "push", "origin", "main", release_version, external=True)
# Upload the distributions.
session.run("twine", "upload", *glob.glob("dist/*"))
|
