Visitar URL original
Generate the release cycle chart directly as SVG by encukou · Pull Request #1034 · python/devguide · GitHub
Skip to content

Generate the release cycle chart directly as SVG #1034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hugovk merged 20 commits into from
Feb 1, 2023
Merged

Generate the release cycle chart directly as SVG #1034

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
0e5ccfe
Generate the release cycle chart directly as SVG
encukou Jan 19, 2023
dfc51ed
Install jinja on GH Actions
encukou Jan 19, 2023
9211356
GHA: Ignore release-cycle.svg, which encodes the current date
encukou Jan 19, 2023
ae1184e
Apply suggestions from code review
hugovk Jan 22, 2023
cfbaa83
Remove .gitattributes for transparency of CSV/SVG changes
hugovk Jan 22, 2023
36fb09f
Sort
hugovk Jan 22, 2023
46d1181
Fix code suggestion application
hugovk Jan 22, 2023
3fc6c69
Re-format with Black
hugovk Jan 22, 2023
d5401af
Newlines
hugovk Jan 22, 2023
0621b28
Move 'today' line to front
hugovk Jan 22, 2023
ceb4034
Rename template to .svg.jinja
hugovk Jan 22, 2023
b163ac4
Override today for testing with reproducible output
hugovk Jan 22, 2023
cee0046
Use black for labels on lighter backgrounds
hugovk Jan 22, 2023
a9d3e6b
Remove commented CSS
hugovk Jan 22, 2023
c747042
Extra whitespace inside template expressions
hugovk Jan 22, 2023
ceb5791
Include final year on x axis but no extra vertical line
hugovk Jan 22, 2023
9830ad7
Silence Windows warnings
hugovk Jan 22, 2023
59c2bbc
Generate release cycle SVG during deploy
hugovk Jan 22, 2023
67099ad
Generate release cycle CSVs during deploy
hugovk Jan 30, 2023
8413255
Remove redundant workflow
hugovk Jan 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Re-format with Black
  • Loading branch information
@hugovk
hugovk committed Jan 22, 2023
commit 3fc6c6907957e916e19daea3a6e2a038e19e8df3
24 changes: 11 additions & 13 deletions _tools/generate_release_cycle.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,14 @@ def csv_date(date_str: str, now_str: str) -> str:
return f"*{date_str}*"
return date_str


def parse_date(date_str: str) -> dt.date:
if len(date_str) == len("yyyy-mm"):
# We need a full yyyy-mm-dd, so let's approximate
return dt.date.fromisoformat(date_str + '-01')
return dt.date.fromisoformat(date_str + "-01")
return dt.date.fromisoformat(date_str)


class Versions:
"""For converting JSON to CSV and SVG."""

Expand All @@ -30,12 +32,12 @@ def __init__(self) -> None:

# Generate a few additional fields
for key, version in self.versions.items():
version['key'] = key
version['first_release_date'] = parse_date(version['first_release'])
version['end_of_life_date'] = parse_date(version['end_of_life'])
version["key"] = key
version["first_release_date"] = parse_date(version["first_release"])
version["end_of_life_date"] = parse_date(version["end_of_life"])
self.sorted_versions = sorted(
self.versions.values(),
key=lambda v: [int(i) for i in v['key'].split(".")],
key=lambda v: [int(i) for i in v["key"].split(".")],
reverse=True,
)

Expand All @@ -56,7 +58,7 @@ def write_csv(self) -> None:
}
headers = row.keys()
cat = "end-of-life" if details["status"] == "end-of-life" else "branches"
versions_by_category[cat][details['key']] = row
versions_by_category[cat][details["key"]] = row

for cat, versions in versions_by_category.items():
with open(f"include/{cat}.csv", "w", encoding="UTF-8", newline="") as file:
Expand All @@ -67,7 +69,7 @@ def write_csv(self) -> None:
def write_svg(self) -> None:
"""Output SVG file."""
env = jinja2.Environment(
loader=jinja2.FileSystemLoader('_tools/'),
loader=jinja2.FileSystemLoader("_tools/"),
autoescape=True,
Comment thread
hugovk marked this conversation as resolved.
lstrip_blocks=True,
trim_blocks=True,
Expand All @@ -92,12 +94,8 @@ def write_svg(self) -> None:
# some positioning numbers in the template as well.
LINE_HEIGHT = 1.5

first_date = min(
ver['first_release_date'] for ver in self.sorted_versions
)
last_date = max(
ver['end_of_life_date'] for ver in self.sorted_versions
)
first_date = min(ver["first_release_date"] for ver in self.sorted_versions)
last_date = max(ver["end_of_life_date"] for ver in self.sorted_versions)

def date_to_x(date: dt.date) -> float:
"""Convert datetime.date to an SVG X coordinate"""
Expand Down