First working version with an example

Author: Pierre-Sassoulas

.flake8

@@ -0,0 +1,5 @@
+[flake8]
+ignore =
+    E203, W503, # Incompatible with black see https://github.com/ambv/black/issues/315
+
+max-line-length=88

.pre-commit-config.yaml

@@ -9,8 +9,17 @@ repos:
       - id: detect-private-key
       - id: end-of-file-fixer
       - id: name-tests-test
-      - id: requirements-txt-fixer
       - id: trailing-whitespace
+  - repo: https://github.com/myint/autoflake
+    rev: v1.4
+    hooks:
+      - id: autoflake
+        args:
+          - --in-place
+          - --remove-all-unused-imports
+          - --expand-star-imports
+          - --remove-duplicate-keys
+          - --remove-unused-variables
   - repo: 'https://github.com/pycqa/isort'
     rev: 5.10.1
     hooks:
@@ -43,5 +52,5 @@ repos:
         entry: pylint
         language: system
         types: [python]
-        args: ["-rn", "-sn", "--fail-on=I"]
+        args: ["-rn", "-sn", "--fail-on=I", "--disable=C0111"]
         exclude: "setup.py"

README.md

@@ -19,3 +19,42 @@ pip install pycrobit
 ```
 
 Or download ``pycrobit.py`` for offline use.
+
+## Example of use
+
+```python
+from pycrobit import Pycrobit
+from colorama import Fore
+
+all_lit = """
+*****
+*****
+*****
+*****
+*****
+"""
+all_off = """
+.....
+.....
+.....
+.....
+....."""
+
+
+pycrobit = Pycrobit(framerate=0.50)
+while True:
+    pycrobit.display(all_lit)  # Lit red by default
+    pycrobit.display(all_off)
+    pycrobit.display(all_lit, {"*": Fore.YELLOW})
+    pycrobit.display(all_off)
+    pycrobit.display(all_lit, {"*": Fore.GREEN})
+    pycrobit.display(all_off)
+    pycrobit.display("*.*.*\n" * 5)
+    pycrobit.wait(-0.25)
+    pycrobit.display("\n".join(".***." * 5))
+    pycrobit.wait(-0.25)
+```
+
+# TODO
+
+Version without using colorama for when you can't install colorama easily.

pycrobit.py

@@ -2,4 +2,80 @@
 Recycle microbits exercises in python using 5 * 5 strings and some coloring.
 """
 
-TODO = 42
+__all__ = ["Pycrobit", "DEFAULT_COLOR_MAP"]
+
+import os
+import time
+from typing import Dict
+
+from colorama import Fore, init
+from colorama.ansi import AnsiFore
+
+init()
+COLORAMA_AVAILABLE = True
+DEFAULT_COLOR_MAP = {".": "", "*": Fore.RED}
+ColorMap = Dict[str, AnsiFore]
+
+
+def validate_pycrobit_str(pycrobit_string: str) -> None:
+    """Validate that the pycrobit string is correct."""
+    strip_line_feed = pycrobit_string.strip("\n ")
+    lines = strip_line_feed.split("\n")
+    assert len(lines) == 5, f"We expected 5 lines in the string and got {lines} "
+    for i, line in enumerate(lines):
+        stripped_line = line.strip(" ")
+        if len(stripped_line) != 5:
+            raise ValueError(
+                f"We expected 5 characters on line n°{i+1} and got "
+                f"{len(stripped_line)} ({stripped_line})"
+            )
+
+
+def validate_color_map(color_map: ColorMap) -> None:
+    """Validate that the color map is correct."""
+    for character, color in color_map.items():
+        if not isinstance(color, str):
+            msg = f"The color '{color}' for '{character}' is invalid."
+            raise ValueError(msg)
+
+
+def clear_terminal() -> None:
+    """Clear the terminal (refresh the screen)."""
+    os.system("cls" if os.name == "nt" else "clear")
+
+
+def colorize(pycrobit_string: str, color_map: ColorMap) -> str:
+    """Colorize a string to be displayed in terminal."""
+    validate_pycrobit_str(pycrobit_string)
+    validate_color_map(color_map)
+    return "".join(f"{color_map.get(px, '')}{px}{Fore.RESET}" for px in pycrobit_string)
+
+
+class Pycrobit:
+
+    """A context manager that act similarly as a microbit but in Python."""
+
+    DEFAULT_FRAMERATE_SECOND = 1.0
+
+    def __init__(self, framerate=DEFAULT_FRAMERATE_SECOND):
+        # No delay for the first display
+        self.framerate = framerate
+        self._switch_frame_after = 0
+
+    def wait(self, time_to_wait: float = 0.0):
+        """Wait for an additional 'time_to_wait'.
+
+        It can be negative to accelerate the framerate."""
+        if self._switch_frame_after + time_to_wait < 0:
+            raise ValueError("pycrobit was asked to wait for a negative time.")
+        self._switch_frame_after += time_to_wait
+
+    def display(self, pycrobit_string: str, color_map: ColorMap = None):
+        """Display the string"""
+        # print(f"entering {pycrobit_string}")
+        clear_terminal()
+        if color_map is None:
+            color_map = DEFAULT_COLOR_MAP
+        print(colorize(pycrobit_string, color_map))
+        time.sleep(self._switch_frame_after)
+        self._switch_frame_after = self.framerate

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pycrobit
-version = 0.0.1
+version = 0.1.0
 description = Recycle microbits exercises in python using 5 * 5 strings and some coloring
 long_description = file: README.md
 long_description_content_type = text/markdown

tests/conftest.py

@@ -0,0 +1,44 @@
+import pytest
+
+
+@pytest.fixture()
+def off():
+    return """\
+.....
+.....
+.....
+.....
+....."""
+
+
+@pytest.fixture()
+def lit():
+    return """
+*****
+*****
+*****
+*****
+*****
+"""
+
+
+@pytest.fixture()
+def diagonal():
+    return """
+.****
+*.***
+**.**
+***.*
+****.
+"""
+
+
+@pytest.fixture()
+def invalid():
+    return """
+.***
+*.***
+*.**
+***.*
+***.
+"""

tests/pycrobit_colormap_test.py

@@ -0,0 +1,10 @@
+import pytest
+from colorama import Fore
+
+from pycrobit import validate_color_map
+
+
+def test_colormap():
+    with pytest.raises(ValueError, match="color '1' for 'x'"):
+        validate_color_map({"x": 1})
+    validate_color_map({"x": Fore.RED})

tests/pycrobit_string_test.py

@@ -0,0 +1,25 @@
+import pytest
+
+from pycrobit import validate_pycrobit_str
+
+
+def test_pycrobit_string():
+    validate_pycrobit_str(
+        """
+12345
+12345
+12345
+12345
+12345
+"""
+    )
+    with pytest.raises(ValueError, match="expected 5 characters on line n°3"):
+        validate_pycrobit_str(
+            """
+        12345
+        12345
+        1234
+        12345
+        12345
+        """
+        )

tests/pycrobit_test.py

@@ -1,8 +1,18 @@
 """Basic tests for pycrobit."""
+import pytest
+from colorama import Fore
 
-from pycrobit import TODO
+from pycrobit import Pycrobit
 
 
-def test_todo():
-    """TODO"""
-    assert TODO
+def test_todo(lit, capsys):
+    pycrobit = Pycrobit(framerate=0.0001)
+    pycrobit.display(lit)
+    pycrobit.display(lit, {"*": Fore.YELLOW})
+    pycrobit.wait(0.002)
+    pycrobit.display(lit, {"*": Fore.GREEN})
+    out, err = capsys.readouterr()
+    assert not err
+    assert "[33m*\x1b[39m\n" in out
+    with pytest.raises(ValueError, match="asked to wait for a negative time"):
+        pycrobit.wait(-1.0)