coco-tools 0.24__tar.gz → 0.25__tar.gz

{coco_tools-0.24 → coco_tools-0.25}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: coco-tools
-Version: 0.24
+Version: 0.25
 Summary: TRS-80 Color Computer Tools
 Author-email: Jamie Cho <jamieleecho@gmail.com>
 License-Expression: GPL-2.0
@@ -14,6 +14,7 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.9.19
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: colormath>=3.0.0
 Requires-Dist: parsimonious>=0.10.0
 Requires-Dist: Pillow>=7.0.0
 Requires-Dist: pypng>=0.0.18
@@ -28,7 +29,7 @@ the [TRS-80 Color Computer](https://en.wikipedia.org/wiki/TRS-80_Color_Computer)
 
 ## Installation
 
-```
+```bash
 # To install via pip
 pip install coco-tools
 
@@ -39,32 +40,11 @@ make install-pre-commit
 make install
 ```
 
-The `Makefile` makes it easy to perform the most common operations:
-* `make all` transpiles several exapmle ECB programs to Basic09
-* `make check-all` runs linting and `uv.lock` checks
-* `make check-lint` checks for linting issues
-* `make check-lock` verifies the `uv.lock` is aligned to `pyproject.toml`
-* `make clean` cleans the virtual environment and caches
-* `make default` runs a default set of checks on the code
-* `make fix-all` formats the code, fixes lint errors and runs locks `uv.lock` to `pyproject.toml`
-* `make fix-format` formats the code
-* `make fix-lint` fixes linting issues
-* `make fix-lint-unsafe` fixes linting issues potentially adding inadvertant bugs
-* `make help` outputs the different make options
-* `make install` build install the distribution
-* `make install-pre-commit` installs pre-commit hooks
-* `make lock` locks `uv.lock` to `pyproject.toml`
-* `make install-pre-commit` installs pre-commit hooks
-* `make run-tests` runs the unit tests
-* `make sync` syncs the python environment with `uv.lock`
-
-`.vscode/settings.json` is set so that unit tests can be run without further configuration.
-
 ## Tools
 
-### [decb-to-b09](./README.decb-to-b09.md)
+### [decb-to-b09](https://github.com/jamieleecho/coco-tools/blob/main/README.decb-to-b09.md)
 
-```
+```bash
 usage: decb-to-b09 [-h] [--version] [-l] [-z] [-s DEFAULT_STRING_STORAGE] [-D] [-w]
                    [-c CONFIG_FILE]
                    program.bas program.b09
@@ -96,7 +76,7 @@ optional arguments:
 
 ### cm3toppm
 
-```
+```bash
 usage: cm3toppm [-h] [--version] [image.cm3] [image.ppm]
 
 Convert RS-DOS CM3 images to PPM
@@ -115,7 +95,7 @@ options:
 
 ### hrstoppm
 
-```
+```bash
 usage: hrstoppm [-h] [-w width] [-r height] [-s bytes] [--version]
                 [image.hrs] [image.ppm]
 
@@ -138,7 +118,7 @@ options:
 
 ### maxtoppm
 
-```
+```bash
 usage: maxtoppm [-h] [--version]
                 [-br | -rb | -br2 | -rb2 | -br3 | -rb3 | -s10 | -s11] [-i]
                 [-w width] [-r height] [-s bytes] [-newsroom]
@@ -183,7 +163,7 @@ Format and size options::
 
 ### mgetoppm
 
-```
+```bash
 usage: mgetoppm [-h] [--version] [image.mge] [image.ppm]
 
 Convert RS-DOS MGE images to PPM
@@ -202,7 +182,7 @@ options:
 
 ### mge_viewer2
 
-```
+```bash
 usage: mge_viewer2 [-h] [--version] [image.mge]
 
 View ColorMax 3 MGE files
@@ -219,7 +199,7 @@ optional arguments:
 
 ### pixtopgm
 
-```
+```bash
 usage: pixtopgm [-h] [--version] image.pix [image.pgm]
 
 Convert RS-DOS PIX images to PGM
@@ -237,7 +217,7 @@ options:
 
 ### rattoppm
 
-```
+```bash
 usage: rattoppm [-h] [--version] [image.rat] [image.ppm]
 
 Convert RS-DOS RAT images to PPM
@@ -255,7 +235,7 @@ options:
 
 ### veftopng
 
-```
+```bash
 usage: veftopng [-h] [--version] image.vef image.png
 
 Convert OS-9 VEF images to PNG
@@ -274,10 +254,42 @@ options:
 
 ## Developing and Testing
 
+You will need a fairly modern python environment with [uv](https://github.com/astral-sh/uv) installed.
+
+You can begin by entering:
+
+```bash
+make install-pre-commit
+make sync
+make run-tests
 ```
-# To set up pre-commit checks
-pre-commit install
 
+The `Makefile` makes it easy to perform the most common operations:
+
+* `make all` transpiles several example ECB programs to Basic09
+* `make basic.dsk os9boot.dsk` builds ECB and OS-9 disks with examples
+* `make check-all` runs linting and `uv.lock` checks
+* `make check-lint` checks for linting issues
+* `make check-lock` verifies the `uv.lock` is aligned to `pyproject.toml`
+* `make clean` cleans the virtual environment and caches
+* `make default` runs a default set of checks on the code
+* `make fix-all` formats the code, fixes lint errors and runs locks `uv.lock` to `pyproject.toml`
+* `make fix-format` formats the code
+* `make fix-lint` fixes linting issues
+* `make fix-lint-unsafe` fixes linting issues potentially adding inadvertant bugs
+* `make help` outputs the different make options
+* `make install` build install the distribution
+* `make install-pre-commit` installs pre-commit hooks
+* `make lock` locks `uv.lock` to `pyproject.toml`
+* `make install-pre-commit` installs pre-commit hooks
+* `make run-tests` runs the unit tests
+* `make sync` syncs the python environment with `uv.lock`
+
+`.vscode/settings.json` is set so that unit tests can be run without further configuration.
+
+You can use Docker to run tests in a Linux environment:
+
+```bash
 # Build the docker image
 docker compose build test
 
@@ -286,38 +298,19 @@ docker compose run test
 
 # Run tests using the source on the host computer
 docker compose run testv
-
-# To develop locally
-pip install -r requirements.txt
-
-# Run linting, build example disk images for basic conversion
-make
-
-# Remove built artifacts
-make clean
-
-# Reformats the code
-make format
-
-# Only runs linting
-make lint
-
-# Only run tests
-make test
-
-# Build basic and os-9 eample images
-make basic.dsk os9boot.dsk
 ```
 
 ## Credits
+
 The programs in the examples/decb and examples/other-decb-examples-to-try directories are from the following sources:
-* alien4k0.bas -- https://github.com/jggames/trs80mc10/blob/9df4c9578250009d68a03101d626faa3c22e7445/quicktype/Arcade/4K/Alien4K/ALIEN4K0.TXT#L4
-* bach.bas -- https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/bach.c10
-* banner.bas -- https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/banner.c10
-* cadnza.bas -- https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/cadnza.c10
-* cflip.bas -- https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/cflip.c10
-* flip.bas -- https://github.com/daftspaniel/RetroCornerRedux/blob/main/Dragon/Originals/FlipBits/flip.bas
-* loops.bas -- https://colorcomputerarchive.com/repo/Documents/Manuals/Hardware/Color%20Computer%203%20Extended%20Basic%20(Tandy).pdf
-* f15eagle.bas -- https://colorcomputerarchive.com/repo/Disks/Magazines/Rainbow%20On%20Disk.zip
-* mars.bas -- https://github.com/jggames/trs80mc10/tree/9df4c9578250009d68a03101d626faa3c22e7445/quicktype/Text%20Adventures/WorkInProgress/Mars
-* saints.bas -- https://colorcomputerarchive.com/repo/Documents/Manuals/Hardware/Color%20Computer%203%20Extended%20Basic%20(Tandy).pdf
+
+* alien4k0.bas -- <https://github.com/jggames/trs80mc10/blob/9df4c9578250009d68a03101d626faa3c22e7445/quicktype/Arcade/4K/Alien4K/ALIEN4K0.TXT#L4>
+* bach.bas -- <https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/bach.c10>
+* banner.bas -- <https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/banner.c10>
+* cadnza.bas -- <https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/cadnza.c10>
+* cflip.bas -- <https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/cflip.c10>
+* flip.bas -- <https://github.com/daftspaniel/RetroCornerRedux/blob/main/Dragon/Originals/FlipBits/flip.bas>
+* loops.bas -- <https://colorcomputerarchive.com/repo/Documents/Manuals/Hardware/Color%20Computer%203%20Extended%20Basic%20(Tandy).pdf>
+* f15eagle.bas -- <https://colorcomputerarchive.com/repo/Disks/Magazines/Rainbow%20On%20Disk.zip>
+* mars.bas -- <https://github.com/jggames/trs80mc10/tree/9df4c9578250009d68a03101d626faa3c22e7445/quicktype/Text%20Adventures/WorkInProgress/Mars>
+* saints.bas -- <https://colorcomputerarchive.com/repo/Documents/Manuals/Hardware/Color%20Computer%203%20Extended%20Basic%20(Tandy).pdf>

{coco_tools-0.24 → coco_tools-0.25}/README.md

@@ -5,7 +5,7 @@ the [TRS-80 Color Computer](https://en.wikipedia.org/wiki/TRS-80_Color_Computer)
 
 ## Installation
 
-```
+```bash
 # To install via pip
 pip install coco-tools
 
@@ -16,32 +16,11 @@ make install-pre-commit
 make install
 ```
 
-The `Makefile` makes it easy to perform the most common operations:
-* `make all` transpiles several exapmle ECB programs to Basic09
-* `make check-all` runs linting and `uv.lock` checks
-* `make check-lint` checks for linting issues
-* `make check-lock` verifies the `uv.lock` is aligned to `pyproject.toml`
-* `make clean` cleans the virtual environment and caches
-* `make default` runs a default set of checks on the code
-* `make fix-all` formats the code, fixes lint errors and runs locks `uv.lock` to `pyproject.toml`
-* `make fix-format` formats the code
-* `make fix-lint` fixes linting issues
-* `make fix-lint-unsafe` fixes linting issues potentially adding inadvertant bugs
-* `make help` outputs the different make options
-* `make install` build install the distribution
-* `make install-pre-commit` installs pre-commit hooks
-* `make lock` locks `uv.lock` to `pyproject.toml`
-* `make install-pre-commit` installs pre-commit hooks
-* `make run-tests` runs the unit tests
-* `make sync` syncs the python environment with `uv.lock`
-
-`.vscode/settings.json` is set so that unit tests can be run without further configuration.
-
 ## Tools
 
-### [decb-to-b09](./README.decb-to-b09.md)
+### [decb-to-b09](https://github.com/jamieleecho/coco-tools/blob/main/README.decb-to-b09.md)
 
-```
+```bash
 usage: decb-to-b09 [-h] [--version] [-l] [-z] [-s DEFAULT_STRING_STORAGE] [-D] [-w]
                    [-c CONFIG_FILE]
                    program.bas program.b09
@@ -73,7 +52,7 @@ optional arguments:
 
 ### cm3toppm
 
-```
+```bash
 usage: cm3toppm [-h] [--version] [image.cm3] [image.ppm]
 
 Convert RS-DOS CM3 images to PPM
@@ -92,7 +71,7 @@ options:
 
 ### hrstoppm
 
-```
+```bash
 usage: hrstoppm [-h] [-w width] [-r height] [-s bytes] [--version]
                 [image.hrs] [image.ppm]
 
@@ -115,7 +94,7 @@ options:
 
 ### maxtoppm
 
-```
+```bash
 usage: maxtoppm [-h] [--version]
                 [-br | -rb | -br2 | -rb2 | -br3 | -rb3 | -s10 | -s11] [-i]
                 [-w width] [-r height] [-s bytes] [-newsroom]
@@ -160,7 +139,7 @@ Format and size options::
 
 ### mgetoppm
 
-```
+```bash
 usage: mgetoppm [-h] [--version] [image.mge] [image.ppm]
 
 Convert RS-DOS MGE images to PPM
@@ -179,7 +158,7 @@ options:
 
 ### mge_viewer2
 
-```
+```bash
 usage: mge_viewer2 [-h] [--version] [image.mge]
 
 View ColorMax 3 MGE files
@@ -196,7 +175,7 @@ optional arguments:
 
 ### pixtopgm
 
-```
+```bash
 usage: pixtopgm [-h] [--version] image.pix [image.pgm]
 
 Convert RS-DOS PIX images to PGM
@@ -214,7 +193,7 @@ options:
 
 ### rattoppm
 
-```
+```bash
 usage: rattoppm [-h] [--version] [image.rat] [image.ppm]
 
 Convert RS-DOS RAT images to PPM
@@ -232,7 +211,7 @@ options:
 
 ### veftopng
 
-```
+```bash
 usage: veftopng [-h] [--version] image.vef image.png
 
 Convert OS-9 VEF images to PNG
@@ -251,10 +230,42 @@ options:
 
 ## Developing and Testing
 
+You will need a fairly modern python environment with [uv](https://github.com/astral-sh/uv) installed.
+
+You can begin by entering:
+
+```bash
+make install-pre-commit
+make sync
+make run-tests
 ```
-# To set up pre-commit checks
-pre-commit install
 
+The `Makefile` makes it easy to perform the most common operations:
+
+* `make all` transpiles several example ECB programs to Basic09
+* `make basic.dsk os9boot.dsk` builds ECB and OS-9 disks with examples
+* `make check-all` runs linting and `uv.lock` checks
+* `make check-lint` checks for linting issues
+* `make check-lock` verifies the `uv.lock` is aligned to `pyproject.toml`
+* `make clean` cleans the virtual environment and caches
+* `make default` runs a default set of checks on the code
+* `make fix-all` formats the code, fixes lint errors and runs locks `uv.lock` to `pyproject.toml`
+* `make fix-format` formats the code
+* `make fix-lint` fixes linting issues
+* `make fix-lint-unsafe` fixes linting issues potentially adding inadvertant bugs
+* `make help` outputs the different make options
+* `make install` build install the distribution
+* `make install-pre-commit` installs pre-commit hooks
+* `make lock` locks `uv.lock` to `pyproject.toml`
+* `make install-pre-commit` installs pre-commit hooks
+* `make run-tests` runs the unit tests
+* `make sync` syncs the python environment with `uv.lock`
+
+`.vscode/settings.json` is set so that unit tests can be run without further configuration.
+
+You can use Docker to run tests in a Linux environment:
+
+```bash
 # Build the docker image
 docker compose build test
 
@@ -263,38 +274,19 @@ docker compose run test
 
 # Run tests using the source on the host computer
 docker compose run testv
-
-# To develop locally
-pip install -r requirements.txt
-
-# Run linting, build example disk images for basic conversion
-make
-
-# Remove built artifacts
-make clean
-
-# Reformats the code
-make format
-
-# Only runs linting
-make lint
-
-# Only run tests
-make test
-
-# Build basic and os-9 eample images
-make basic.dsk os9boot.dsk
 ```
 
 ## Credits
+
 The programs in the examples/decb and examples/other-decb-examples-to-try directories are from the following sources:
-* alien4k0.bas -- https://github.com/jggames/trs80mc10/blob/9df4c9578250009d68a03101d626faa3c22e7445/quicktype/Arcade/4K/Alien4K/ALIEN4K0.TXT#L4
-* bach.bas -- https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/bach.c10
-* banner.bas -- https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/banner.c10
-* cadnza.bas -- https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/cadnza.c10
-* cflip.bas -- https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/cflip.c10
-* flip.bas -- https://github.com/daftspaniel/RetroCornerRedux/blob/main/Dragon/Originals/FlipBits/flip.bas
-* loops.bas -- https://colorcomputerarchive.com/repo/Documents/Manuals/Hardware/Color%20Computer%203%20Extended%20Basic%20(Tandy).pdf
-* f15eagle.bas -- https://colorcomputerarchive.com/repo/Disks/Magazines/Rainbow%20On%20Disk.zip
-* mars.bas -- https://github.com/jggames/trs80mc10/tree/9df4c9578250009d68a03101d626faa3c22e7445/quicktype/Text%20Adventures/WorkInProgress/Mars
-* saints.bas -- https://colorcomputerarchive.com/repo/Documents/Manuals/Hardware/Color%20Computer%203%20Extended%20Basic%20(Tandy).pdf
+
+* alien4k0.bas -- <https://github.com/jggames/trs80mc10/blob/9df4c9578250009d68a03101d626faa3c22e7445/quicktype/Arcade/4K/Alien4K/ALIEN4K0.TXT#L4>
+* bach.bas -- <https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/bach.c10>
+* banner.bas -- <https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/banner.c10>
+* cadnza.bas -- <https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/cadnza.c10>
+* cflip.bas -- <https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/cflip.c10>
+* flip.bas -- <https://github.com/daftspaniel/RetroCornerRedux/blob/main/Dragon/Originals/FlipBits/flip.bas>
+* loops.bas -- <https://colorcomputerarchive.com/repo/Documents/Manuals/Hardware/Color%20Computer%203%20Extended%20Basic%20(Tandy).pdf>
+* f15eagle.bas -- <https://colorcomputerarchive.com/repo/Disks/Magazines/Rainbow%20On%20Disk.zip>
+* mars.bas -- <https://github.com/jggames/trs80mc10/tree/9df4c9578250009d68a03101d626faa3c22e7445/quicktype/Text%20Adventures/WorkInProgress/Mars>
+* saints.bas -- <https://colorcomputerarchive.com/repo/Documents/Manuals/Hardware/Color%20Computer%203%20Extended%20Basic%20(Tandy).pdf>

{coco_tools-0.24 → coco_tools-0.25}/coco/__init__.py

@@ -1,2 +1,2 @@
 # __version__ MUST be defined on line 2
-__version__ = "0.24"
+__version__ = "0.25"

{coco_tools-0.24 → coco_tools-0.25}/coco/b09/compiler.py

@@ -3,6 +3,7 @@ from typing import List
 
 from coco import b09
 from coco.b09 import error_handler
+from coco.b09.configs import CompilerConfigs
 from coco.b09.elements import (
     Basic09CodeStatement,
     BasicExpressionList,
@@ -13,8 +14,7 @@ from coco.b09.elements import (
     BasicRunCall,
     BasicVar,
 )
-from coco.b09.configs import CompilerConfigs
-from coco.b09.grammar import grammar, PROCNAME_REGEX
+from coco.b09.grammar import PROCNAME_REGEX, grammar
 from coco.b09.parser import BasicVisitor
 from coco.b09.procbank import ProcedureBank
 from coco.b09.prog import BasicProg
@@ -29,8 +29,8 @@ from coco.b09.visitors import (
     DeclareImplicitArraysVisitor,
     GetDimmedArraysVisitor,
     JoystickVisitor,
-    LineNumberFilterVisitor,
     LineNumberCheckerVisitor,
+    LineNumberFilterVisitor,
     LineReferenceVisitor,
     LineZeroFilterVisitor,
     SetDimStringStorageVisitor,

{coco_tools-0.24 → coco_tools-0.25}/coco/b09/configs.py

@@ -1,8 +1,9 @@
 import re
 from pathlib import Path
+from typing import Dict
+
 from pydantic import BaseModel, Field, field_validator
 from pydantic_yaml import parse_yaml_raw_as
-from typing import Dict
 
 
 class StringConfigs(BaseModel):

{coco_tools-0.24 → coco_tools-0.25}/coco/b09/elements.py

@@ -1,7 +1,7 @@
 from abc import ABC, abstractmethod
 from collections import defaultdict
 from itertools import chain
-from typing import Dict, List, Literal, TYPE_CHECKING, Union
+from typing import TYPE_CHECKING, Dict, List, Literal, Union
 
 from coco.b09 import DEFAULT_STR_STORAGE
 

{coco_tools-0.24 → coco_tools-0.25}/coco/b09/procbank.py

@@ -1,12 +1,11 @@
 import importlib.resources as pkg_resources
 import re
-
 from collections import defaultdict
 from typing import Dict, Set
 
 from coco import b09
-from .. import resources
 
+from .. import resources
 
 # Procedure names that start with a procedure keyword.
 PROCEDURE_START_PREFIX = re.compile(r"(?i)procedure\s+(\w+)\s*$")

{coco_tools-0.24 → coco_tools-0.25}/coco/b09/visitors.py

@@ -1,4 +1,4 @@
-from typing import Dict, List, Set, TYPE_CHECKING
+from typing import TYPE_CHECKING, Dict, List, Set
 
 from coco import b09
 from coco.b09.configs import StringConfigs
@@ -15,8 +15,8 @@ from coco.b09.elements import (
     BasicFunctionalExpression,
     BasicGoStatements,
     BasicHbuffStatement,
-    BasicJoystkExpression,
     BasicInputStatement,
+    BasicJoystkExpression,
     BasicLine,
     BasicLiteral,
     BasicNextStatement,

{coco_tools-0.24 → coco_tools-0.25}/coco/decb_to_b09.py

@@ -11,7 +11,6 @@ import sys
 from coco import __version__
 from coco.b09.compiler import convert_file
 
-
 DESCRIPTION = """Convert a Color BASIC program to a BASIC09 program
 Copyright (c) 2023 by Jamie Cho
 Version: {}""".format(__version__)

{coco_tools-0.24 → coco_tools-0.25}/coco/maxtoppm.py

@@ -23,7 +23,6 @@ from coco.util import (
     strtoio,
 )
 
-
 PIXEL_MODE_BW = 0
 PIXEL_MODE_BR = 1
 PIXEL_MODE_RB = 2

{coco_tools-0.24 → coco_tools-0.25}/coco/mge_viewer2.py

@@ -11,12 +11,11 @@
 
 import argparse
 import sys
-from tkinter import Tk, Canvas, PhotoImage, NW
+from tkinter import NW, Canvas, PhotoImage, Tk
 
 from coco import __version__
 from coco.util import stdiotobuffer
 
-
 # Color Computer 3 RGB Palette in Photoimage color format
 RGB = [
     "#000000",  # Black