bloops 0.2.0__tar.gz → 0.2.1__tar.gz

{bloops-0.2.0 → bloops-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: bloops
-Version: 0.2.0
+Version: 0.2.1
 Summary: An AoPS-like BBCode to HTML transpiler, with live-preview and support for Asymptote geometry diagrams.
 Project-URL: Documentation, https://github.com/Bubu-Droid/bloops/blob/main/docs/api.md
 Project-URL: Issues, https://github.com/Bubu-Droid/bloops/issues
@@ -9,19 +9,30 @@ Author-email: Bubu-Droid <bubu@bubudroid.me>
 License-Expression: MIT
 License-File: LICENSE
 Keywords: aops,asymptote,bbcode,converter,diagrams,geometry,html,latex,live-preview,markup,math,tex,transpiler
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Education
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Text Processing :: Markup
+Classifier: Topic :: Text Processing :: Markup :: HTML
+Classifier: Typing :: Typed
 Requires-Python: >=3.12
 Requires-Dist: livereload>=2.7.1
 Requires-Dist: watchdog>=6
 Description-Content-Type: text/markdown
 
 <div align="center">
-    <img src="https://raw.githubusercontent.com/Bubu-Droid/bloops/main/assets/banner.png" style="width: 90%; height: auto;">
+    <img src="https://raw.githubusercontent.com/Bubu-Droid/bloops/main/assets/banner.png" width="90%">
 </div>
 
 <hr>
@@ -30,7 +41,7 @@ Bloops is an AoPS-like **BBCode to HTML transpiler**
 written in Python, with **live-preview**
 and support for **Asymptote geometry diagrams**.
 
-<div align="center" style="height: 28px; display: flex; flex-wrap: wrap; justify-content: center; align-items: center; gap: 4px; margin: 6px 0;">
+<div align="center">
     <a href="https://github.com/Bubu-Droid/bloops/releases/latest">
         <img alt="PyPI Version" src="https://img.shields.io/pypi/v/bloops?label=PyPI&style=for-the-badge&logo=pypi&logoColor=c0caf5&labelColor=1a1b26&color=7aa2f7&v=1" />
     </a>
@@ -42,7 +53,7 @@ and support for **Asymptote geometry diagrams**.
     </a>
 </div>
 
-<div align="center" style="height: 28px; display: flex; flex-wrap: wrap; justify-content: center; align-items: center; gap: 4px; margin: 6px 0;">
+<div align="center">
     <a href="https://pypi.org/project/bloops/">
         <img alt="PyPI Python Version" src="https://img.shields.io/pypi/pyversions/bloops?style=for-the-badge&logo=python&logoColor=c0caf5&labelColor=1a1b26&color=7aa2f7&v=1" />
     </a>
@@ -54,7 +65,7 @@ and support for **Asymptote geometry diagrams**.
     </a>
 </div>
 
-<div align="center" style="height: 28px; display: flex; flex-wrap: wrap; justify-content: center; align-items: center; gap: 4px; margin: 6px 0;">
+<div align="center">
     <a href="https://github.com/Bubu-Droid/bloops/blob/main/LICENSE">
         <img alt="License" src="https://img.shields.io/github/license/Bubu-Droid/bloops?label=License&style=for-the-badge&labelColor=1a1b26&color=7dcfff" />
     </a>
@@ -127,7 +138,7 @@ Install `bloops` from PyPI. Here is the
 | Flag | Long Flag      | Description                                                               |
 | ---- | -------------- | ------------------------------------------------------------------------- |
 | `-h` | `--help`       | Show help message for usage of `bloops`.                                  |
-| `-v` | `--version`    | Show the version of `bloops`.                                             |
+| `-V` | `--version`    | Show the version of `bloops`.                                             |
 | `-c` | `--build-cont` | Watch `content.bbcode` for changes and continuously rebuild `index.html`. |
 | `-p` | `--preview`    | Launch a local web live-server to preview `index.html`.                   |
 | `-i` | `--input`      | (**Required**) Input directory containing `content.bbcode`.               |
@@ -195,9 +206,9 @@ Here are reference tables for each BBCode tag bloops uses:
 
 <details><summary>[color]</summary>
 
-| Option  | Mandatory | Description                              |
-| ------- | :-------: | ---------------------------------------- |
-| `color` |    YES    | Color code in hex (with the leading \#). |
+| Option | Mandatory | Description                              |
+| ------ | :-------: | ---------------------------------------- |
+| `hex`  |    YES    | Color code in hex (with the leading \#). |
 
 </details>
 
@@ -391,6 +402,7 @@ how to implement it.
   (I'll be very glad if someone suggests me a solution for this;
   I've thought about it myself, but couldn't really come up with
   anything.)
+- [ ] Switch lists to sets to optimize speed.
 
 <p align="right"><a href="#index">&uarr; Back to top</a></p>
 

{bloops-0.2.0 → bloops-0.2.1}/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-    <img src="https://raw.githubusercontent.com/Bubu-Droid/bloops/main/assets/banner.png" style="width: 90%; height: auto;">
+    <img src="https://raw.githubusercontent.com/Bubu-Droid/bloops/main/assets/banner.png" width="90%">
 </div>
 
 <hr>
@@ -8,7 +8,7 @@ Bloops is an AoPS-like **BBCode to HTML transpiler**
 written in Python, with **live-preview**
 and support for **Asymptote geometry diagrams**.
 
-<div align="center" style="height: 28px; display: flex; flex-wrap: wrap; justify-content: center; align-items: center; gap: 4px; margin: 6px 0;">
+<div align="center">
     <a href="https://github.com/Bubu-Droid/bloops/releases/latest">
         <img alt="PyPI Version" src="https://img.shields.io/pypi/v/bloops?label=PyPI&style=for-the-badge&logo=pypi&logoColor=c0caf5&labelColor=1a1b26&color=7aa2f7&v=1" />
     </a>
@@ -20,7 +20,7 @@ and support for **Asymptote geometry diagrams**.
     </a>
 </div>
 
-<div align="center" style="height: 28px; display: flex; flex-wrap: wrap; justify-content: center; align-items: center; gap: 4px; margin: 6px 0;">
+<div align="center">
     <a href="https://pypi.org/project/bloops/">
         <img alt="PyPI Python Version" src="https://img.shields.io/pypi/pyversions/bloops?style=for-the-badge&logo=python&logoColor=c0caf5&labelColor=1a1b26&color=7aa2f7&v=1" />
     </a>
@@ -32,7 +32,7 @@ and support for **Asymptote geometry diagrams**.
     </a>
 </div>
 
-<div align="center" style="height: 28px; display: flex; flex-wrap: wrap; justify-content: center; align-items: center; gap: 4px; margin: 6px 0;">
+<div align="center">
     <a href="https://github.com/Bubu-Droid/bloops/blob/main/LICENSE">
         <img alt="License" src="https://img.shields.io/github/license/Bubu-Droid/bloops?label=License&style=for-the-badge&labelColor=1a1b26&color=7dcfff" />
     </a>
@@ -105,7 +105,7 @@ Install `bloops` from PyPI. Here is the
 | Flag | Long Flag      | Description                                                               |
 | ---- | -------------- | ------------------------------------------------------------------------- |
 | `-h` | `--help`       | Show help message for usage of `bloops`.                                  |
-| `-v` | `--version`    | Show the version of `bloops`.                                             |
+| `-V` | `--version`    | Show the version of `bloops`.                                             |
 | `-c` | `--build-cont` | Watch `content.bbcode` for changes and continuously rebuild `index.html`. |
 | `-p` | `--preview`    | Launch a local web live-server to preview `index.html`.                   |
 | `-i` | `--input`      | (**Required**) Input directory containing `content.bbcode`.               |
@@ -173,9 +173,9 @@ Here are reference tables for each BBCode tag bloops uses:
 
 <details><summary>[color]</summary>
 
-| Option  | Mandatory | Description                              |
-| ------- | :-------: | ---------------------------------------- |
-| `color` |    YES    | Color code in hex (with the leading \#). |
+| Option | Mandatory | Description                              |
+| ------ | :-------: | ---------------------------------------- |
+| `hex`  |    YES    | Color code in hex (with the leading \#). |
 
 </details>
 
@@ -369,6 +369,7 @@ how to implement it.
   (I'll be very glad if someone suggests me a solution for this;
   I've thought about it myself, but couldn't really come up with
   anything.)
+- [ ] Switch lists to sets to optimize speed.
 
 <p align="right"><a href="#index">&uarr; Back to top</a></p>
 

{bloops-0.2.0 → bloops-0.2.1}/docs/api.md

@@ -14,11 +14,15 @@ with MathJax and Syntax Highlighting support.
 
 Args:
     text: Raw BBCode text content.
-    bbcode_tags: List of tag configurations and rule definitions.
+    bbcode_tags: Mapping of tag names to their opening pattern,
+        closing pattern and permitted arguments. See `BBCODE_TAGS`.
 
 Returns:
     A fully formatted HTML document string.
 
+Raises:
+    SyntaxError: If a tag has no matching closing tag.
+
 ## `bracer.py`
 
 ### `gobble_inside_delim` (Function)
@@ -68,6 +72,16 @@ Raises:
         matching closing tag cannot be found.
     RuntimeError: If parser enters an unexpected state.
 
+## `cli.py`
+
+### `main` (Function)
+
+Parse command-line arguments and run the build and preview process.
+
+Reads input/output paths and continuous build or live preview flags
+from CLI arguments, setting default fallback paths when necessary,
+and invokes the build and preview pipeline.
+
 ## `validator.py`
 
 ### `validate_bbcode` (Function)
@@ -80,13 +94,14 @@ dictionary mapping each diagram label to its character index.
 
 Args:
     text: Raw BBCode input string.
-    bbcode_tags: List of tag configurations, matching patterns,
-        and permitted argument lists.
+    bbcode_tags: Mapping of tag names to their opening pattern,
+        closing pattern and permitted arguments. See `BBCODE_TAGS`.
 
 Returns:
     A dictionary mapping diagram labels to their starting index.
 
 Raises:
+    SyntaxError: If a tag has no matching closing tag.
     ValueError: If an invalid argument is supplied or duplicate
         diagram labels are encountered.
 
@@ -104,6 +119,10 @@ Args:
     text: Entire input text containing BBCode and Asymptote code.
     in_dir: Source directory containing the build cache folder.
     out_dir: Target directory where compiled SVG images are stored.
+    bbcode_tags: Mapping of tag names to their opening pattern,
+        closing pattern and permitted arguments. See `BBCODE_TAGS`.
 
 Raises:
+    FileNotFoundError: If `build/cache.json` does not exist in
+        `in_dir`, or the `asy` executable is not installed.
     ValueError: If Asymptote compilation fails.

{bloops-0.2.0 → bloops-0.2.1}/pyproject.toml

@@ -26,12 +26,23 @@ license-files = [ "LICEN[CS]E*" ]
 authors = [ { name = "Bubu-Droid", email = "bubu@bubudroid.me" } ]
 requires-python = ">=3.12"
 classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Education",
+  "Natural Language :: English",
   "Operating System :: OS Independent",
   "Programming Language :: Python :: 3 :: Only",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: 3.14",
   "Programming Language :: Python :: 3.15",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Topic :: Education",
+  "Topic :: Scientific/Engineering :: Mathematics",
+  "Topic :: Text Processing :: Markup",
+  "Topic :: Text Processing :: Markup :: HTML",
+  "Typing :: Typed",
 ]
 dynamic = [ "version" ]
 dependencies = [
@@ -56,9 +67,14 @@ build.targets.sdist.include = [ "/src", "/tests", "/docs", "/example" ]
 
 [tool.ruff]
 line-length = 80
-lint.extend-select = [ "ANN" ]
+lint.extend-select = [ "ANN", "D", "DOC" ]
+lint.per-file-ignores.".github/**" = [ "D", "DOC" ]
+lint.per-file-ignores."tests/**" = [ "D", "DOC" ]
 lint.unfixable = [ "F401" ]
 
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
 [tool.basedpyright]
 executionEnvironments = [
   { root = "tests", reportPrivateUsage = false },

bloops-0.2.1/src/bloops/__about__.py

@@ -0,0 +1,5 @@
+"""Version, author and license metadata for bloops."""
+
+__version__ = "0.2.1"
+__author__ = "Bubu-Droid"
+__license__ = "MIT"

bloops-0.2.1/src/bloops/__init__.py

@@ -0,0 +1,6 @@
+"""An AoPS-like BBCode to HTML transpiler with Asymptote diagram support.
+
+Use `bloops.validator.validate_bbcode` and
+`bloops.validator.compile_asy_diagrams` to check a document and render its
+diagrams, then `bloops.bloopser.convert_bbcode_to_html` to produce the HTML.
+"""

bloops-0.2.1/src/bloops/__main__.py

@@ -0,0 +1,6 @@
+"""Run the bloops command-line interface with `python -m bloops`."""
+
+from bloops.cli import main
+
+if __name__ == "__main__":
+    main()

{bloops-0.2.0 → bloops-0.2.1}/src/bloops/_build_and_preview.py

@@ -53,7 +53,6 @@ class _Handler(PatternMatchingEventHandler):
             out_dir: Path to the directory for compiled static output.
             file_content: Initial text content of the BBCode file.
         """
-
         super().__init__(
             patterns=["content.bbcode"],
             ignore_directories=True,
@@ -77,7 +76,6 @@ class _Handler(PatternMatchingEventHandler):
         Args:
             event: File system event describing the modification.
         """
-
         new_content = self.input_file.read_text(encoding="utf-8").strip()
         if self.file_content == new_content:
             return
@@ -97,7 +95,6 @@ class _Handler(PatternMatchingEventHandler):
             Exception: Re-raises any syntax or compilation exception encountered
                 during execution.
         """
-
         try:
             print(
                 "Verifying syntax and generating newly added / changed asymptote diagrams (if any)..."
@@ -147,16 +144,8 @@ def main(
         FileNotFoundError: If the input directory or source file is missing.
         NotADirectoryError: If specified paths are not valid directories.
     """
-
     input_file = in_dir / "content.bbcode"
     output_file = in_dir / "index.html"
-    style_file = in_dir / "static" / "style.css"
-    style_file.parent.mkdir(parents=True, exist_ok=True)
-    script_file = in_dir / "static" / "script.js"
-    script_file.parent.mkdir(parents=True, exist_ok=True)
-    build_dir = in_dir / "build/"
-    build_dir.mkdir(parents=True, exist_ok=True)
-    asy_cache_file = build_dir / "cache.json"
 
     if not in_dir.exists():
         raise FileNotFoundError("Input directory not found.")
@@ -168,6 +157,14 @@ def main(
         out_dir.mkdir(parents=True, exist_ok=True)
     if not out_dir.is_dir():
         raise NotADirectoryError(f"{out_dir} is not a directory.")
+
+    style_file = in_dir / "static" / "style.css"
+    script_file = in_dir / "static" / "script.js"
+    style_file.parent.mkdir(exist_ok=True)
+    build_dir = in_dir / "build/"
+    build_dir.mkdir(exist_ok=True)
+    asy_cache_file = build_dir / "cache.json"
+
     file_content = input_file.read_text(encoding="utf-8").strip()
     if not style_file.exists():
         _ = style_file.write_text(STYLESHEET, encoding="utf-8")

{bloops-0.2.0 → bloops-0.2.1}/src/bloops/_helper.py

@@ -13,7 +13,6 @@ def get_error_line(text: str, index: int) -> tuple[int, str]:
     Returns:
         A tuple containing the 1-based line number and line text string.
     """
-
     line_num = text.count("\n", 0, index)
 
     return (line_num + 1, text.splitlines()[line_num])
@@ -38,7 +37,6 @@ def get_tag_and_args(
     Raises:
         SyntaxError: If no valid match is found at the given index.
     """
-
     match = open_delim.match(text, open_delim_start_index)
     if not match:
         error_line = get_error_line(text, open_delim_start_index)

{bloops-0.2.0 → bloops-0.2.1}/src/bloops/bloopser.py

@@ -25,12 +25,15 @@ def convert_bbcode_to_html(
 
     Args:
         text: Raw BBCode text content.
-        bbcode_tags: List of tag configurations and rule definitions.
+        bbcode_tags: Mapping of tag names to their opening pattern,
+            closing pattern and permitted arguments. See `BBCODE_TAGS`.
 
     Returns:
         A fully formatted HTML document string.
-    """
 
+    Raises:
+        SyntaxError: If a tag has no matching closing tag.
+    """
     for tag_tuple in bbcode_tags.values():
         open_delim = tag_tuple[0]
         close_delim = tag_tuple[1]
@@ -70,7 +73,6 @@ def _convert_tag_to_html(
     Returns:
         The rendered HTML replacement string for the BBCode element.
     """
-
     tag_and_args = get_tag_and_args(text, open_delim_start_index, open_delim)
     tag, args = tag_and_args
 

{bloops-0.2.0 → bloops-0.2.1}/src/bloops/bracer.py

@@ -22,7 +22,6 @@ def gobble_inside_delim(
     Returns:
         The inner text string enclosed by the matching delimiters.
     """
-
     close_delim_end_index = get_close_delim_end_index(
         text, open_delim_start_index, open_delim, close_delim
     )
@@ -53,7 +52,6 @@ def gobble_around_delim(
     Returns:
         Substring spanning from opening tag start to closing tag end.
     """
-
     close_delim_end_index = get_close_delim_end_index(
         text, open_delim_start_index, open_delim, close_delim
     )
@@ -86,7 +84,6 @@ def get_close_delim_end_index(
             matching closing tag cannot be found.
         RuntimeError: If parser enters an unexpected state.
     """
-
     open_delim_counter = 1
     close_delim_counter = 0
 
@@ -109,7 +106,7 @@ def get_close_delim_end_index(
         if not close_delim_match:
             error_line = get_error_line(text, index - 1)
             raise SyntaxError(
-                "Failed to find an opening pair for delimiter."
+                "Failed to find a closing pair for delimiter."
                 + "\n\n"
                 + f"{error_line[0]}: {error_line[1]}"
             )

{bloops-0.2.0 → bloops-0.2.1}/src/bloops/cli.py

@@ -19,7 +19,6 @@ def main() -> None:
     from CLI arguments, setting default fallback paths when necessary,
     and invokes the build and preview pipeline.
     """
-
     parser = argparse.ArgumentParser(
         prog="bloops",
         description="An AoPS-like BBCode to HTML transpiler written in Python,\

{bloops-0.2.0 → bloops-0.2.1}/src/bloops/validator.py

@@ -32,17 +32,17 @@ def validate_bbcode(
 
     Args:
         text: Raw BBCode input string.
-        bbcode_tags: List of tag configurations, matching patterns,
-            and permitted argument lists.
+        bbcode_tags: Mapping of tag names to their opening pattern,
+            closing pattern and permitted arguments. See `BBCODE_TAGS`.
 
     Returns:
         A dictionary mapping diagram labels to their starting index.
 
     Raises:
+        SyntaxError: If a tag has no matching closing tag.
         ValueError: If an invalid argument is supplied or duplicate
             diagram labels are encountered.
     """
-
     label_dict: dict[str, int] = {}
     for tag, tag_tuple in bbcode_tags.items():
         open_delim = tag_tuple[0]
@@ -92,11 +92,14 @@ def compile_asy_diagrams(
         text: Entire input text containing BBCode and Asymptote code.
         in_dir: Source directory containing the build cache folder.
         out_dir: Target directory where compiled SVG images are stored.
+        bbcode_tags: Mapping of tag names to their opening pattern,
+            closing pattern and permitted arguments. See `BBCODE_TAGS`.
 
     Raises:
+        FileNotFoundError: If `build/cache.json` does not exist in
+            `in_dir`, or the `asy` executable is not installed.
         ValueError: If Asymptote compilation fails.
     """
-
     build_dir = in_dir / "build/"
     asy_cache_file = build_dir / "cache.json"
 
@@ -168,7 +171,6 @@ def _validate_args(
         ValueError: If unknown attributes or missing required parameters
             are encountered, or if attribute values are invalid.
     """
-
     tag_and_args = get_tag_and_args(text, open_delim_start_index, open_delim)
     tag, args = tag_and_args
 

{bloops-0.2.0 → bloops-0.2.1}/src/bloops/vars.py

@@ -1,3 +1,5 @@
+"""Definitions of the BBCode tags supported by bloops."""
+
 import re
 
 BBCODE_TAGS: dict[str, tuple[re.Pattern[str], re.Pattern[str], list[str]]] = {
@@ -107,3 +109,14 @@ BBCODE_TAGS: dict[str, tuple[re.Pattern[str], re.Pattern[str], list[str]]] = {
     "h5": (re.compile(r"\[(h5)\]"), re.compile(r"\[/h5\]"), []),
     "h6": (re.compile(r"\[(h6)\]"), re.compile(r"\[/h6\]"), []),
 }
+"""Mapping of each tag name to `(open_pattern, close_pattern, valid_args)`.
+
+- `open_pattern` matches the opening tag. Group 1 captures the tag name
+  and, for tags that take arguments, group 2 captures the raw argument
+  string.
+- `close_pattern` matches the closing tag.
+- `valid_args` lists the argument names the tag accepts, and is empty
+  for tags without arguments.
+
+Tags are processed in the order they appear here.
+"""

{bloops-0.2.0 → bloops-0.2.1}/tests/test_bracer.py

@@ -35,7 +35,7 @@ asdf [/asy]"""
                 text, 11, BBCODE_TAGS["asy"][0], BBCODE_TAGS["asy"][1]
             )
         assert context.type is SyntaxError
-        assert "Failed to find an opening pair for delimiter." in str(
+        assert "Failed to find a closing pair for delimiter." in str(
             context.value
         )
         assert "4:" in str(context.value)

{bloops-0.2.0 → bloops-0.2.1}/tests/test_validator.py

@@ -200,7 +200,7 @@ lorem [asy src=/home/bubu/meow.png label=hello]some random stuff
                 pathlib.Path("./build/"),
             )
         assert context.type is SyntaxError
-        assert "Failed to find an opening pair for delimiter." in str(
+        assert "Failed to find a closing pair for delimiter." in str(
             context.value
         )
         assert "39:" in str(context.value)

bloops-0.2.0/src/bloops/__about__.py

@@ -1,3 +0,0 @@
-__version__ = "0.2.0"
-__author__ = "Bubu-Droid"
-__license__ = "MIT"

bloops-0.2.0/src/bloops/__main__.py

@@ -1,4 +0,0 @@
-from bloops.cli import main
-
-if __name__ == "__main__":
-    main()