matrix-commander 1.0.1

#!/usr/bin/env python3
import re
import shutil
import subprocess
import sys
from datetime import datetime
from os import R_OK, access
from os.path import isfile

# runs program (cargo run) to create the help/manual.txt file
#
# replace this pattern:
# ```
# Usage: ...
# ```
# in the README.md file with the help/manual.txt file

# datetime object containing current date and time
now = datetime.now()
date_string = now.strftime("%Y%m%d-%H%M%S")

helpfile = "help/manual.txt"
filename = "README.md"
# create_help_script = "scripts/create-help-manual.sh"

if isfile(filename) and access(filename, R_OK):
    # so that subprocess can execute it without PATH
    filename = "./" + filename
    helpfile = "./" + helpfile
else:
    filename = "../" + filename
    helpfile = "../" + helpfile
    if not (isfile(filename) and access(filename, R_OK)):
        print(
            f"Error: file {filename[3:]} not found, neither in "
            "local nor in parent directory."
        )
        sys.exit(1)

backupfile = filename + "." + date_string
shutil.copy2(filename, backupfile)

with open(helpfile, "w") as f:
    # tty size defaults to 80 columns
    bashCmd = ["cargo", "run", "--", "--manual"]
    process = subprocess.Popen(bashCmd, stdout=f)
    _, error = process.communicate()
    if error:
        print("Error: Running cargo failed. Not enough disk space?")
        print(error)
        sys.exit(1)

with open(helpfile, "r+") as f:
    helptext = f.read()
    if len(helptext) < 100:
        print(
            f"Error: file {helpfile} has length {len(helptext)}. Something is wrong. Aborting."
        )
        sys.exit(1)

# remove escaped color sequences from helpfile, turned colored text into normal text
bashCmd = ["sed", "-i", "s," + "\x1b" + "\\[[0-9;]*[a-zA-Z],,g", helpfile]
process = subprocess.Popen(
    bashCmd,
)
_, error = process.communicate()
if error:
    print(error)

bashCmd = ["wc", "-L", helpfile]  # max line length
process = subprocess.Popen(bashCmd, stdout=subprocess.PIPE)
output, error = process.communicate()
if error:
    print(error)
else:
    output = output.decode("utf-8").strip("\n")
    print(f"Maximum line length is {output}")

with open(helpfile, "r+") as f:
    helptext = f.read()
    print(f"Length of new {helpfile} file is: {len(helptext)}")


# We no longer change the REAME.md file (June 2026)
#
# with open(filename, "r+") as f:
#     text = f.read()
#     print(f"Length of {filename} before: {len(text)}")
#     text = re.sub(
#         r"```\nWelcome to[\s\S]*?```",
#         "```\n"
#         + helptext.translate(
#             str.maketrans(
#                 {
#                     "\\": r"\\",
#                 }
#             )
#         )
#         + "```",
#         text,
#     )
#
#     text = re.sub(
#         r"target/debug/matrix-commander-rs",
#         "matrix-commander-rs",
#         text,
#     )
#
#     print(f"Length of {filename} after:  {len(text)}")
#     f.seek(0)
#     f.write(text)
#     f.truncate()
#

bashCmd = ["diff", filename, backupfile]
process = subprocess.Popen(bashCmd, stdout=subprocess.PIPE)
output, error = process.communicate()
if error:
    print(error)
else:
    output = output.decode("utf-8").strip("\n")
    print(f"Diff is:\n{output}")