8000 Initial commit · hugovk/python-docs-bootstrapper@8287059 · GitHub
[go: up one dir, main page]
Skip to content

Commit 8287059

Browse files
egeakmanegeakman
committed
Initial commit
0 parents  commit 8287059

File tree

10 files changed

+525
-0
lines changed

10 files changed

+525
-0
lines changed

‎.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
**/__pycache__/
2+
*.egg-info/
3+
dist/
4+
build/
5+
.mypy_cache/
6+
.pytest_cache/

‎.pre-commit-config.yaml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
repos:
2+
- repo: https://github.com/pycqa/isort
3+
rev: 5.12.0
4+
hooks:
5+
- id: isort
6+
name: isort (python)
7+
8+
- repo: https://github.com/psf/black
9+
rev: 23.7.0
10+
hooks:
11+
- id: black
12+
name: black (python)
13+
14+
- repo: https://github.com/pre-commit/pre-commit-hooks
15+
rev: v4.4.0
16+
hooks:
17+
- id: end-of-file-fixer
18+
- id: trailing-whitespace

‎LICENSE

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
Creative Commons Legal Code
2+
3+
CC0 1.0 Universal
4+
5+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
6+
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
7+
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
8+
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
9+
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
10+
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
11+
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
12+
HEREUNDER.
13+
14+
Statement of Purpose
15+
16+
The laws of most jurisdictions throughout the world automatically confer
17+
exclusive Copyright and Related Rights (defined below) upon the creator
18+
and subsequent owner(s) (each and all, an "owner") of an original work of
19+
authorship and/or a database (each, a "Work").
20+
21+
Certain owners wish to permanently relinquish those rights to a Work for
22+
the purpose of contributing to a commons of creative, cultural and
23+
scientific works ("Commons") that the public can reliably and without fear
24+
of later claims of infringement build upon, modify, incorporate in other
25+
works, reuse and redistribute as freely as possible in any form whatsoever
26+
and for any purposes, including without limitation commercial purposes.
27+
These owners may contribute to the Commons to promote the ideal of a free
28+
culture and the further production of creative, cultural and scientific
29+
works, or to gain reputation or greater distribution for their Work in
30+
part through the use and efforts of others.
31+
32+
For these and/or other purposes and motivations, and without any
33+
expectation of additional consideration or compensation, the person
34+
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
35+
is an owner of Copyright and Related Rights in the Work, voluntarily
36+
elects to apply CC0 to the Work and publicly distribute the Work under its
37+
terms, with knowledge of his or her Copyright and Related Rights in the
38+
Work and the meaning and intended legal effect of CC0 on those rights.
39+
40+
1. Copyright and Related Rights. A Work made available under CC0 may be
41+
protected by copyright and related or neighboring rights ("Copyright and
42+
Related Rights"). Copyright and Related Rights include, but are not
43+
limited to, the following:
44+
45+
i. the right to reproduce, adapt, distribute, perform, display,
46+
communicate, and translate a Work;
47+
ii. moral rights retained by the original author(s) and/or performer(s);
48+
iii. publicity and privacy rights pertaining to a person's image or
49+
likeness depicted in a Work;
50+
iv. rights protecting against unfair competition in regards to a Work,
51+
subject to the limitations in paragraph 4(a), below;
52+
v. rights protecting the extraction, dissemination, use and reuse of data
53+
in a Work;
54+
vi. database rights (such as those arising under Directive 96/9/EC of the
55+
European Parliament and of the Council of 11 March 1996 on the legal
56+
protection of databases, and under any national implementation
57+
thereof, including any amended or successor version of such
58+
directive); and
59+
vii. other similar, equivalent or corresponding rights throughout the
60+
world based on applicable law or treaty, and any national
61+
implementations thereof.
62+
63+
2. Waiver. To the greatest extent permitted by, but not in contravention
64+
of, applicable law, Affirmer hereby overtly, fully, permanently,
65+
irrevocably and unconditionally waives, abandons, and surrenders all of
66+
Affirmer's Copyright and Related Rights and associated claims and causes
67+
of action, whether now known or unknown (including existing as well as
68+
future claims and causes of action), in the Work (i) in all territories
69+
worldwide, (ii) for the maximum duration provided by applicable law or
70+
treaty (including future time extensions), (iii) in any current or future
71+
medium and for any number of copies, and (iv) for any purpose whatsoever,
72+
including without limitation commercial, advertising or promotional
73+
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
74+
member of the public at large and to the detriment of Affirmer's heirs and
75+
successors, fully intending that such Waiver shall not be subject to
76+
revocation, rescission, cancellation, termination, or any other legal or
77+
equitable action to disrupt the quiet enjoyment of the Work by the public
78+
as contemplated by Affirmer's express Statement of Purpose.
79+
80+
3. Public License Fallback. Should any part of the Waiver for any reason
81+
be judged legally invalid or ineffective under applicable law, then the
82+
Waiver shall be preserved to the maximum extent permitted taking into
83+
account Affirmer's express Statement of Purpose. In addition, to the
84+
extent the Waiver is so judged Affirmer hereby grants to each affected
85+
person a royalty-free, non transferable, non sublicensable, non exclusive,
86+
irrevocable and unconditional license to exercise Affirmer's Copyright and
87+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
88+
maximum duration provided by applicable law or treaty (including future
89+
time extensions), (iii) in any current or future medium and for any number
90+
of copies, and (iv) for any purpose whatsoever, including without
91+
limitation commercial, advertising or promotional purposes (the
92+
"License"). The License shall be deemed effective as of the date CC0 was
93+
applied by Affirmer to the Work. Should any part of the License for any
94+
reason be judged legally invalid or ineffective under applicable law, such
95+
partial invalidity or ineffectiveness shall not invalidate the remainder
96+
of the License, and in such case Affirmer hereby affirms that he or she
97+
will not (i) exercise any of his or her remaining Copyright and Related
98+
Rights in the Work or (ii) assert any associated claims and causes of
99+
action with respect to the Work, in either case contrary to Affirmer's
100+
express Statement of Purpose.
101+
102+
4. Limitations and Disclaimers.
103+
104+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
105+
surrendered, licensed or otherwise affected by this document.
106+
b. Affirmer offers the Work as-is and makes no representations or
107+
warranties of any kind concerning the Work, express, implied,
108+
statutory or otherwise, including without limitation warranties of
109+
title, merchantability, fitness for a particular purpose, non
110+
infringement, or the absence of latent or other defects, accuracy, or
111+
the present or absence of errors, whether or not discoverable, all to
112+
the greatest extent permissible under applicable law.
113+
c. Affirmer disclaims responsibility for clearing rights of other persons
114+
that may apply to the Work or any use thereof, including without
115+
limitation any person's Copyright and Related Rights in the Work.
116+
Further, Affirmer disclaims responsibility for obtaining any necessary
117+
consents, permissions or other rights required for any use of the
118+
Work.
119+
d. Affirmer understands and acknowledges that Creative Commons is not a
120+
party to this document and has no duty or obligation with respect to
121+
this CC0 or use of the Work.

‎README.md

Whitespace-only changes.

‎bootstrapper/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
from .bootstrapper import *

‎bootstrapper/bootstrapper.py

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
import glob
2+
import os
3+
import re
4+
import shutil
5+
import subprocess
6+
import urllib.error
7+
import urllib.request
8+
from argparse import ArgumentParser
9+
from pathlib import Path
10+
from subprocess import PIPE
11+
12+
13+
class Bootstrapper:
14+
def __init__(self, language: str, branch: str = "3.12") -> None:
15+
self.language = language
16+
self.branch = branch
17+
self.translation_repo = f"python-docs-{self.language}"
18+
self.cpython_repo = f"{self.translation_repo}/venv/cpython"
19+
self.readme_url = "https://raw.githubusercontent.com/egeakman/python-docs-bootstrapper/master/bootstrapper/data/README.md"
20+
self.gitignore_url = "https://raw.githubusercontent.com/egeakman/python-docs-bootstrapper/master/bootstrapper/data/.gitignore"
21+
self.makefile_url = "https://raw.githubusercontent.com/egeakman/python-docs-bootstrapper/master/bootstrapper/data/Makefile"
22+
23+
def _request(self, url: str) -> str:
24+
with urllib.request.urlopen(url) as response:
25+
return response.read().decode()
26+
27+
def create_dirs(self) -> None:
28+
os.makedirs(self.translation_repo, exist_ok=True)
29+
os.makedirs(self.cpython_repo, exist_ok=True)
30+
31+
def setup_cpython_repo(self) -> None:
32+
if not os.path.exists(f"{self.cpython_repo}/.git") and not os.path.isdir(
33+
f"{self.cpython_repo}/.git"
34+
):
35+
subprocess.run(
36+
[
37+
"git",
38+
"clone",
39+
"https://github.com/python/cpython.git",
40+
self.cpython_repo,
41+
]
42+
)
43+
subprocess.run(["git", "-C", self.cpython_repo, "checkout", self.branch])
44+
subprocess.run(["git", "-C", self.cpython_repo, "pull", "--ff-only"])
45+
subprocess.run(
46+
[
47+
"sphinx-build",
48+
"-jauto",
49+
"-QDgettext_compact=0",
50+
"-bgettext",
51+
"Doc",
52+
"pot",
53+
],
54+
cwd=self.cpython_repo,
55+
)
56+
57+
def setup_translation_repo(self) -> None:
58+
subprocess.run(["git", "init"], cwd=self.translation_repo)
59+
subprocess.run(["git", "branch", "-m", self.branch], cwd=self.translation_repo)
60+
61+
files = glob.glob(f"{self.cpython_repo}/pot/**/*.pot") + glob.glob(
62+
f"{self.cpython_repo}/pot/*.pot"
63+
)
64+
65+
files = [path.replace("\\", "/") for path in files]
66+
67+
for file in files:
68+
dest_path = (
69+
f"{self.translation_repo}/{'/'.join(file.split('/')[4:])}".replace(
70+
".pot", ".po"
71+
)
72+
)
73+
74+
if len(file.split("/")) > 5:
75+
os.makedirs("/".join(dest_path.split("/")[:2]), exist_ok=True)
76+
77+
shutil.copyfile(file, dest_path)
78+
files[files.index(file)] = dest_path
79+
80+
for file in files:
81+
with open(file, "r", encoding="utf-8") as f:
82+
contents = f.read()
83+
contents = re.sub("^#: .*Doc/", "#: ", contents, flags=re.M)
84+
with open(file, "w", encoding="utf-8") as f:
85+
f.write(contents)
86+
87+
def create_readme(self) -> None:
88+
try:
89+
readme = self._request(self.readme_url)
90+
except (urllib.error.HTTPError, urllib.error.URLError):
91+
readme = Path(f"{os.path.dirname(__file__)}/data/README.md").read_text(
92+
encoding="utf-8"
93+
)
94+
95+
readme = readme.replace("{{translation.language}}", self.language)
96+
97+
with open(f"{self.translation_repo}/README.md", "w", encoding="utf-8") as f:
98+
f.write(readme)
99+
100+
def create_gitignore(self) -> None:
101+
try:
102+
gitignore = self._request(self.gitignore_url)
103+
except (urllib.error.HTTPError, urllib.error.URLError):
104+
gitignore = Path(f"{os.path.dirname(__file__)}/data/.gitignore").read_text(
105+
encoding="utf-8"
106+
)
107+
108+
with open(f"{self.translation_repo}/.gitignore", "w", encoding="utf-8") as f:
109+
f.write(gitignore)
110+
111+
def create_makefile(self) -> None:
112+
try:
113+
makefile = self._request(self.makefile_url)
114+
except (urllib.error.HTTPError, urllib.error.URLError):
115+
makefile = Path(f"{os.path.dirname(__file__)}/data/Makefile").read_text(
116+
encoding="utf-8"
117+
)
118+
119+
head = (
120+
subprocess.run(
121+
["git", "-C", self.cpython_repo, "rev-parse", "HEAD"], stdout=PIPE
122+
)
123+
.stdout.strip()
124+
.decode()
125+
)
126+
127+
makefile = makefile.replace("{{translation.language}}", self.language)
128+
makefile = makefile.replace("{{translation.branch}}", self.branch)
129+
makefile = makefile.replace("{{translation.head}}", head)
130+
131+
with open(f"{self.translation_repo}/Makefile", "w", encoding="utf-8") as f:
132+
f.write(makefile)
133+
134+
def run(self) -> None:
135+
self.create_dirs()
136+
self.setup_cpython_repo()
137+
self.setup_translation_repo()
138+
self.create_readme()
139+
self.create_gitignore()
140+
self.create_makefile()
141+
142+
143+
def main() -> None:
144+
parser = ArgumentParser()
145+
parser.add_argument(
146+
"language",
147+
type=str,
148+
help="IETF language tag (e.g. tr, pt-br)",
149+
)
150+
parser.add_argument(
151+
"-b", "--branch", type=str, default="3.12", help="CPython branch (e.g. 3.12)"
152+
)
153+
args = parser.parse_args()
154+
Bootstrapper(args.language.lower(), args.branch).run()
155+
156+
157+
if __name__ == "__main__":
158+
main()

‎bootstrapper/data/.gitignore

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
*.mo
2+
*.po.bak
3+
*.pot
4+
.DS_Store
5+
.idea/
6+
.pospell/
7+
.potodo/
8+
.venv/
9+
.vs/
10+
.vscode/
11+
locales/
12+
venv/
13+
__pycache__/

0 commit comments

Comments
 (0)
0