User-friendly logging, CI

Author: egeakman

.github/workflows/tests.yaml

@@ -0,0 +1,42 @@
+name: Tests
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - "**"
+  pull_request:
+    branches:
+      - "**"
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12.0-beta.4"]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install the package
+        run: pip install .
+
+      - name: Run the package
+        run: bootstrapper tr -b 3.12
+
+      - name: See results
+        shell: bash
+        run: |
+          cd python-docs-tr
+          tree . -L 2
+          cat about.po
+          echo "================================"
+          cat library/functions.po

bootstrapper/bootstrapper.py

@@ -1,15 +1,33 @@
 import glob
+import logging
 import os
 import re
 import shutil
 import subprocess
+import sys
 import urllib.error
 import urllib.request
 from argparse import ArgumentParser
 from pathlib import Path
 from subprocess import PIPE
 
 
+class _NoNewLine(logging.StreamHandler):
+    def emit(self, record):
+        msg = self.format(record)
+        stream = self.stream
+        terminator = "\n" if msg.endswith("\n") else ""
+        stream.write(msg + terminator)
+        self.flush()
+
+
+logger = logging.getLogger()
+logger.setLevel(logging.INFO)
+handler = _NoNewLine()
+handler.setFormatter(logging.Formatter("%(message)s"))
+logger.addHandler(handler)
+
+
 class Bootstrapper:
     def __init__(self, language: str, branch: str = "3.12") -> None:
         self.language = language
@@ -25,23 +43,36 @@ def _request(self, url: str) -> str:
             return response.read().decode()
 
     def create_dirs(self) -> None:
+        logger.info("Creating directories...")
         os.makedirs(self.translation_repo, exist_ok=True)
         os.makedirs(self.cpython_repo, exist_ok=True)
+        print("✅")
 
     def setup_cpython_repo(self) -> None:
         if not os.path.exists(f"{self.cpython_repo}/.git") and not os.path.isdir(
             f"{self.cpython_repo}/.git"
         ):
+            logger.info("Cloning CPython repo...")
             subprocess.run(
                 [
                     "git",
                     "clone",
                     "https://github.com/python/cpython.git",
                     self.cpython_repo,
-                ]
+                    "-q",
+                ],
+                check=True,
             )
-        subprocess.run(["git", "-C", self.cpython_repo, "checkout", self.branch])
-        subprocess.run(["git", "-C", self.cpython_repo, "pull", "--ff-only"])
+            print("✅")
+
+        subprocess.run(
+            ["git", "-C", self.cpython_repo, "checkout", self.branch, "-q"], check=True
+        )
+        subprocess.run(
+            ["git", "-C", self.cpython_repo, "pull", "--ff-only", "-q"], check=True
+        )
+
+        logger.info("Building gettext files...")
         subprocess.run(
             [
                 "sphinx-build",
@@ -52,12 +83,19 @@ def setup_cpython_repo(self) -> None:
                 "pot",
             ],
             cwd=self.cpython_repo,
+            check=True,
         )
+        print("✅")
 
     def setup_translation_repo(self) -> None:
-        subprocess.run(["git", "init"], cwd=self.translation_repo)
-        subprocess.run(["git", "branch", "-m", self.branch], cwd=self.translation_repo)
+        logger.info("Initializing translation repo...")
+        subprocess.run(["git", "init", "-q"], cwd=self.translation_repo, check=True)
+        subprocess.run(
+            ["git", "branch", "-m", self.branch], cwd=self.translation_repo, check=True
+        )
+        print("✅")
 
+        logger.info("Copying gettext files...")
         files = glob.glob(f"{self.cpython_repo}/pot/**/*.pot") + glob.glob(
             f"{self.cpython_repo}/pot/*.pot"
         )
@@ -76,18 +114,25 @@ def setup_translation_repo(self) -> None:
 
             shutil.copyfile(file, dest_path)
             files[files.index(file)] = dest_path
+        print("✅")
 
+        logger.info("Cleaning up gettext files...")
         for file in files:
             with open(file, "r", encoding="utf-8") as f:
                 contents = f.read()
                 contents = re.sub("^#: .*Doc/", "#: ", contents, flags=re.M)
             with open(file, "w", encoding="utf-8") as f:
                 f.write(contents)
+        print("✅")
 
     def create_readme(self) -> None:
+        logger.info("Creating README.md...")
         try:
             readme = self._request(self.readme_url)
         except (urllib.error.HTTPError, urllib.error.URLError):
+            logger.warning(
+                "\n ⚠️ Failed to fetch README.md from GitHub, using local copy..."
+            )
             readme = Path(f"{os.path.dirname(__file__)}/data/README.md").read_text(
                 encoding="utf-8"
             )
@@ -96,29 +141,41 @@ def create_readme(self) -> None:
 
         with open(f"{self.translation_repo}/README.md", "w", encoding="utf-8") as f:
             f.write(readme)
+        print("✅")
 
     def create_gitignore(self) -> None:
+        logger.info("Creating .gitignore...")
         try:
             gitignore = self._request(self.gitignore_url)
         except (urllib.error.HTTPError, urllib.error.URLError):
+            logger.warning(
+                "\n ⚠️ Failed to fetch .gitignore from GitHub, using local copy..."
+            )
             gitignore = Path(f"{os.path.dirname(__file__)}/data/.gitignore").read_text(
                 encoding="utf-8"
             )
 
         with open(f"{self.translation_repo}/.gitignore", "w", encoding="utf-8") as f:
             f.write(gitignore)
+        print("✅")
 
     def create_makefile(self) -> None:
+        logging.info("Creating .makefile...")
         try:
             makefile = self._request(self.makefile_url)
         except (urllib.error.HTTPError, urllib.error.URLError):
+            logger.warning(
+                "\n ⚠️ Failed to fetch Makefile from GitHub, using local copy..."
+            )
             makefile = Path(f"{os.path.dirname(__file__)}/data/Makefile").read_text(
                 encoding="utf-8"
             )
 
         head = (
             subprocess.run(
-                ["git", "-C", self.cpython_repo, "rev-parse", "HEAD"], stdout=PIPE
+                ["git", "-C", self.cpython_repo, "rev-parse", "HEAD"],
+                stdout=PIPE,
+                check=True,
             )
             .stdout.strip()
             .decode()
@@ -130,14 +187,22 @@ def create_makefile(self) -> None:
 
         with open(f"{self.translation_repo}/Makefile", "w", encoding="utf-8") as f:
             f.write(makefile)
+        print("✅")
 
     def run(self) -> None:
-        self.create_dirs()
-        self.setup_cpython_repo()
-        self.setup_translation_repo()
-        self.create_readme()
-        self.create_gitignore()
-        self.create_makefile()
+        try:
+            self.create_dirs()
+            self.setup_cpython_repo()
+            self.setup_translation_repo()
+            self.create_readme()
+            self.create_gitignore()
+            self.create_makefile()
+            logger.info(f"🎉 Done bootstrapping the {self.language} translation ✅\n")
+        except Exception as e:
+            logger.critical(
+                f"❌ Bootstrapping of the {self.language} translation failed: {e}\n"
+            )
+            sys.exit(1)
 
 
 def main() -> None:
@@ -151,7 +216,7 @@ def main() -> None:
         "-b", "--branch", type=str, default="3.12", help="CPython branch (e.g. 3.12)"
     )
     args = parser.parse_args()
-    Bootstrapper(args.language.lower(), args.branch).run()
+    Bootstrapper(args.language.lower().replace("_", "-"), args.branch).run()
 
 
 if __name__ == "__main__":

setup.py

@@ -1,5 +1,7 @@
 from setuptools import find_packages, setup
 
+version = "0.1.1"
+
 with open("README.md", "r", encoding="utf-8") as f:
     long_description = f.read()
 
@@ -11,9 +13,9 @@
     description="Bootstrapper for Python documentation translations",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    version="0.1.0",
-    license="CC0-1.0",
-    download_url="https://github.com/egeakman/python-docs-bootstrapper/archive/0.1.0.tar.gz",
+    version=version,
+    license="MIT",
+    download_url=f"https://github.com/egeakman/python-docs-bootstrapper/archive/{version}.tar.gz",
     packages=find_packages(where="."),
     install_requires=["sphinx==4.5.0"],
     include_package_data=True,
@@ -31,7 +33,7 @@
         "Programming Language :: Python :: 3 :: Only",
         "Development Status :: 5 - Production/Stable",
         "Environment :: Console",
-        "License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication",
+        "License :: OSI Approved :: MIT License",
         "Operating System :: Microsoft :: Windows",
         "Operating System :: POSIX :: Linux",
         "Operating System :: MacOS :: MacOS X",