Usage Guide¶

uwotm8 example.txt

uwotm8 file1.txt file2.md file3.py

uwotm8 ./my_project/

echo "I love the color gray and my favorite food is filet mignon." | uwotm8
# Output: "I love the colour grey and my favourite food is filet mignon."

usage: uwotm8 [-h] [--check] [--strict] [--comments-only] [--include INCLUDE [INCLUDE ...]] [--exclude EXCLUDE [EXCLUDE ...]] [-o OUTPUT] [--version] [src ...]

Convert American English spelling to British English spelling.

positional arguments:
  src                   Files or directories to convert. If not provided, reads from stdin.

options:
  -h, --help            show this help message and exit
  --check               Don't write the files back, just return status. Return code 0 means nothing would change. Return code 1 means some files would be reformatted.
  --strict              Raise an exception if a word cannot be converted.
  --comments-only       For Python files, only convert comments and docstrings, leaving code unchanged.
  --include INCLUDE [INCLUDE ...]
                        File extensions to include when processing directories. Default: .py .txt .md
  --exclude EXCLUDE [EXCLUDE ...]
                        Paths to exclude when processing directories.
  -o OUTPUT, --output OUTPUT
                        Output file (when processing a single file). If not provided, content is written back to source file.
  --version             show program's version number and exit

uwotm8 --check myproject/

uwotm8 american.txt -o british.txt

uwotm8 --comments-only myproject/src/

uwotm8 myproject/ --include .md .rst

uwotm8 myproject/ --exclude myproject/vendor/ myproject/generated/

from uwotm8 import convert_american_to_british_spelling

# Basic usage
text = "The color of the theater is gray."
result = convert_american_to_british_spelling(text)
print(result)  # "The colour of the theatre is grey."

# With strict mode
try:
    result = convert_american_to_british_spelling(text, strict=True)
except Exception as e:
    print(f"Conversion error: {e}")

from uwotm8 import convert_file

# Convert a file in-place
convert_file("document.txt")

# Convert a file and write to a new file
convert_file("document.txt", "document_gb.txt")

# Check if changes would be made without modifying the file
would_change = convert_file("document.txt", check=True)
if would_change:
    print("File would be modified")
else:
    print("No changes needed")

from uwotm8 import convert_python_comments_only

# Convert only comments and docstrings in a Python file, preserving code
convert_python_comments_only("script.py")

# Convert comments/docstrings and write to a new file
convert_python_comments_only("script.py", "script_gb.py")

# Check mode
would_change = convert_python_comments_only("script.py", check=True)
if would_change:
    print("Comments/docstrings would be modified")
else:
    print("No changes needed")

from uwotm8 import process_paths

# Process multiple files and directories
total, modified = process_paths(["file1.txt", "directory/"])
print(f"Processed {total} files, modified {modified}")

# Check mode
total, modified = process_paths(["file1.txt", "directory/"], check=True)
print(f"Would modify {modified} of {total} files")

# Process only comments and docstrings in Python files
total, modified = process_paths(["src/"], comments_only=True)
print(f"Modified comments in {modified} of {total} files")

from uwotm8 import convert_stream

# Process a stream of lines
with open("input.txt", "r") as f:
    for converted_line in convert_stream(f):
        print(converted_line, end="")

# Input Python file:
# This comment has color in it
def set_color(color_value):
    """Process the color parameter."""
    return color_value  # Return the color

# After running: uwotm8 --comments-only file.py
# This comment has colour in it
def set_color(color_value):
    """Process the colour parameter."""
    return color_value  # Return the colour

# Original:
def process_data(color_map, flavor_list):
    """Process data.

    Args:
        color_map: A mapping of colors to values.
        flavor_list: A list of flavors to process.
    """
    return color_map

# After conversion with --comments-only:
def process_data(color_map, flavor_list):
    """Process data.

    Args:
        color_map: A mapping of colours to values.
        flavor_list: A list of flavours to process.
    """
    return color_map

echo "The colors are red and blue, but a 3-color system is used." | uwotm8
# Output: "The colours are red and blue, but a 3-color system is used."

echo "The `setColor(color)` function sets the color." | uwotm8
# Output: "The `setColor(color)` function sets the colour."

echo "Visit http://example.com/color-picker to select a color." | uwotm8
# Output: "Visit http://example.com/color-picker to select a colour."

echo "This program uses an analog signal processor." | uwotm8
# Output: "This program uses an analog signal processor."