bloops 0.0.2__tar.gz → 0.2.0__tar.gz

{bloops-0.0.2 → bloops-0.2.0}/.gitignore

@@ -1,4 +1,3 @@
 __pycache__/
 build/
 dist/
-static/

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

@@ -1,8 +1,8 @@
 Metadata-Version: 2.5
 Name: bloops
-Version: 0.0.2
+Version: 0.2.0
 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: Documentation, https://github.com/Bubu-Droid/bloops/blob/main/docs/api.md
 Project-URL: Issues, https://github.com/Bubu-Droid/bloops/issues
 Project-URL: Repository, https://github.com/Bubu-Droid/bloops
 Author-email: Bubu-Droid <bubu@bubudroid.me>
@@ -21,7 +21,7 @@ Requires-Dist: watchdog>=6
 Description-Content-Type: text/markdown
 
 <div align="center">
-    <img src="assets/banner.png" style="width: 90%; height: auto;">
+    <img src="https://raw.githubusercontent.com/Bubu-Droid/bloops/main/assets/banner.png" style="width: 90%; height: auto;">
 </div>
 
 <hr>
@@ -30,31 +30,31 @@ Bloops is an AoPS-like **BBCode to HTML transpiler**
 written in Python, with **live-preview**
 and support for **Asymptote geometry diagrams**.
 
-<div align="center">
+<div align="center" style="height: 28px; display: flex; flex-wrap: wrap; justify-content: center; align-items: center; gap: 4px; margin: 6px 0;">
     <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" />
+        <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>
-    <a href="https://github.com/Bubu-Droid/bloops/actions/workflows/prek.yaml">
-        <img alt="Prek CI Status" src="https://img.shields.io/github/actions/workflow/status/Bubu-Droid/bloops/prek.yaml?label=CI&style=for-the-badge&logo=githubactions&logoColor=c0caf5&labelColor=1a1b26&color=9ece6a" />
+    <a href="https://github.com/Bubu-Droid/bloops/actions/workflows/prek.yml">
+        <img alt="Prek CI Status" src="https://img.shields.io/github/actions/workflow/status/Bubu-Droid/bloops/prek.yml?label=CI&style=for-the-badge&logo=githubactions&logoColor=c0caf5&labelColor=1a1b26&color=9ece6a" />
     </a>
-    <a href="https://github.com/Bubu-Droid/bloops/actions/workflows/pytest.yaml">
-        <img alt="Unit Tests Status" src="https://img.shields.io/github/actions/workflow/status/Bubu-Droid/bloops/pytest.yaml?label=Unit%20Tests&style=for-the-badge&logo=pytest&logoColor=c0caf5&labelColor=1a1b26&color=9ece6a" />
+    <a href="https://github.com/Bubu-Droid/bloops/actions/workflows/pytest.yml">
+        <img alt="Unit Tests Status" src="https://img.shields.io/github/actions/workflow/status/Bubu-Droid/bloops/pytest.yml?label=Unit%20Tests&style=for-the-badge&logo=pytest&logoColor=c0caf5&labelColor=1a1b26&color=9ece6a" />
     </a>
 </div>
 
-<div align="center">
+<div align="center" style="height: 28px; display: flex; flex-wrap: wrap; justify-content: center; align-items: center; gap: 4px; margin: 6px 0;">
     <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" />
+        <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>
     <a href="https://github.com/Bubu-Droid/bloops/issues">
         <img alt="GitHub Issues" src="https://img.shields.io/github/issues/Bubu-Droid/bloops?label=Issues&style=for-the-badge&logo=github&logoColor=c0caf5&labelColor=1a1b26&color=e0af68" />
     </a>
-    <a href="https://github.com/Bubu-Droid/bloops/actions/workflows/codeql.yaml">
-        <img alt="CodeQL Status" src="https://img.shields.io/github/actions/workflow/status/Bubu-Droid/bloops/codeql.yaml?label=CodeQL&style=for-the-badge&logo=github&logoColor=c0caf5&labelColor=1a1b26&color=bb9af7" />
+    <a href="https://github.com/Bubu-Droid/bloops/actions/workflows/codeql.yml">
+        <img alt="CodeQL Status" src="https://img.shields.io/github/actions/workflow/status/Bubu-Droid/bloops/codeql.yml?label=CodeQL&style=for-the-badge&logo=github&logoColor=c0caf5&labelColor=1a1b26&color=bb9af7" />
     </a>
 </div>
 
-<div align="center">
+<div align="center" style="height: 28px; display: flex; flex-wrap: wrap; justify-content: center; align-items: center; gap: 4px; margin: 6px 0;">
     <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>
@@ -110,7 +110,11 @@ for vector diagram rendering
 Install `bloops` from PyPI. Here is the
 [PyPI listing](https://pypi.org/project/bloops/).
 
-- I suggest using `uv`: run ```uv tool install bloops```.
+- I suggest using `uv`:
+  - Run `uv tool install bloops` if you'd like to use `bloops`
+  just as a CLI tool.
+  - Run `uv add bloops` if you you'd like to import `bloops`
+  as a package in your project.
 - Or, if you want to use `pip`: run `pip install bloops`.
 - AUR entry is yet to be added.
 
@@ -241,6 +245,14 @@ Here are reference tables for each BBCode tag bloops uses:
 
 </details>
 
+<details><summary>[hide]</summary>
+
+| Option  | Mandatory | Description                                         |
+| ------- | :-------: | --------------------------------------------------- |
+| `label` |    YES    | Label to be used as the summary for hidden details. |
+
+</details>
+
 <details><summary>math environments</summary>
 
 Currently, the following math box tags are supported:
@@ -260,6 +272,11 @@ proof and solutions.
 
 <details><summary>tags without any options</summary>
 
+| Tag                                | Purpose                                          |
+| ---------------------------------- | ------------------------------------------------ |
+| `[sidemark][/sidemark]`            | To put a number in the subscript for a sidenote. |
+| `[sidenote]<your-note>[/sidenote]` | To write a note to be put aside.                 |
+
 | Tag     | HTML Counterpart |
 | ------- | ---------------- |
 | `[b]`   | `<strong>`       |
@@ -281,9 +298,9 @@ proof and solutions.
 <br>
 
 An example showcasing the use of tags mentioned above has been
-provided in [example/content.bbcode](example/content.bbcode)
+provided in [example/content.bbcode][content.bbcode]
 and the corresponding generated HTML file is present in
-[example/index.html](example/index.html).
+[example/index.html][example.html].
 
 ## API Reference
 
@@ -299,11 +316,11 @@ If you want to convert a BBCode text into HTML using `bloops`,
 first run `validate_bbcode`, then `compile_asy_diagrams`, and
 finally `convert_bbcode_to_html` on the text.
 
-Bloops also provides the global constants under the `vars` module
-which provides `BBCODE_TAGS`, `STYLESHEET`, and `ERROR_TEMPLATE`.
+Bloops also provides the `BBCODE_TAGS` global constant
+under the `vars` module.
 
 A detailed documentation of these API endpoints can be found in
-[docs/API.md](docs/API.md).
+[docs/api.md][api.md].
 
 ## FAQs
 
@@ -353,7 +370,7 @@ need JS for running simple static pages.
 ## Contribution
 
 Contributions are very welcome!
-Please read [CONTRIBUTING.md](CONTRIBUTING.md) for a guide on
+Please read [CONTRIBUTING.md][CONTRIBUTING.md] for a guide on
 how to contribute. I'm against the idea of using AI
 for writing hobby projects; however, I have no
 problem if someone else uses them. If you're using AI assistance
@@ -368,11 +385,16 @@ how to implement it.
 ## TODOs
 
 - [ ] Implement a post-processor which adds paragraph tags around
-every disjoint block of HTML code.
-- [ ] Change `BBCODE_TAGS` to a dict instead of a list.
-- [ ] Handle `]` inside arguments of BBCode tags.
-- [ ] Add script placeholder to HTML templates.
-- [ ] De-couple templates and stylesheets by moving them
-to their independent files.
+  every disjoint block of HTML code.
+- [ ] Shift avatar to integration server.
+- [ ] Handle `[` or `]` inside arguments of BBCode tags.
+  (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.)
 
 <p align="right"><a href="#index">&uarr; Back to top</a></p>
+
+[content.bbcode]: https://github.com/Bubu-Droid/bloops/blob/main/example/content.bbcode
+[example.html]: https://github.com/Bubu-Droid/bloops/blob/main/example/index.html
+[api.md]: https://github.com/Bubu-Droid/bloops/blob/main/docs/api.md
+[CONTRIBUTING.md]: https://github.com/Bubu-Droid/bloops/blob/main/CONTRIBUTING.md

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

@@ -1,5 +1,5 @@
 <div align="center">
-    <img src="assets/banner.png" style="width: 90%; height: auto;">
+    <img src="https://raw.githubusercontent.com/Bubu-Droid/bloops/main/assets/banner.png" style="width: 90%; height: auto;">
 </div>
 
 <hr>
@@ -8,31 +8,31 @@ Bloops is an AoPS-like **BBCode to HTML transpiler**
 written in Python, with **live-preview**
 and support for **Asymptote geometry diagrams**.
 
-<div align="center">
+<div align="center" style="height: 28px; display: flex; flex-wrap: wrap; justify-content: center; align-items: center; gap: 4px; margin: 6px 0;">
     <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" />
+        <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>
-    <a href="https://github.com/Bubu-Droid/bloops/actions/workflows/prek.yaml">
-        <img alt="Prek CI Status" src="https://img.shields.io/github/actions/workflow/status/Bubu-Droid/bloops/prek.yaml?label=CI&style=for-the-badge&logo=githubactions&logoColor=c0caf5&labelColor=1a1b26&color=9ece6a" />
+    <a href="https://github.com/Bubu-Droid/bloops/actions/workflows/prek.yml">
+        <img alt="Prek CI Status" src="https://img.shields.io/github/actions/workflow/status/Bubu-Droid/bloops/prek.yml?label=CI&style=for-the-badge&logo=githubactions&logoColor=c0caf5&labelColor=1a1b26&color=9ece6a" />
     </a>
-    <a href="https://github.com/Bubu-Droid/bloops/actions/workflows/pytest.yaml">
-        <img alt="Unit Tests Status" src="https://img.shields.io/github/actions/workflow/status/Bubu-Droid/bloops/pytest.yaml?label=Unit%20Tests&style=for-the-badge&logo=pytest&logoColor=c0caf5&labelColor=1a1b26&color=9ece6a" />
+    <a href="https://github.com/Bubu-Droid/bloops/actions/workflows/pytest.yml">
+        <img alt="Unit Tests Status" src="https://img.shields.io/github/actions/workflow/status/Bubu-Droid/bloops/pytest.yml?label=Unit%20Tests&style=for-the-badge&logo=pytest&logoColor=c0caf5&labelColor=1a1b26&color=9ece6a" />
     </a>
 </div>
 
-<div align="center">
+<div align="center" style="height: 28px; display: flex; flex-wrap: wrap; justify-content: center; align-items: center; gap: 4px; margin: 6px 0;">
     <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" />
+        <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>
     <a href="https://github.com/Bubu-Droid/bloops/issues">
         <img alt="GitHub Issues" src="https://img.shields.io/github/issues/Bubu-Droid/bloops?label=Issues&style=for-the-badge&logo=github&logoColor=c0caf5&labelColor=1a1b26&color=e0af68" />
     </a>
-    <a href="https://github.com/Bubu-Droid/bloops/actions/workflows/codeql.yaml">
-        <img alt="CodeQL Status" src="https://img.shields.io/github/actions/workflow/status/Bubu-Droid/bloops/codeql.yaml?label=CodeQL&style=for-the-badge&logo=github&logoColor=c0caf5&labelColor=1a1b26&color=bb9af7" />
+    <a href="https://github.com/Bubu-Droid/bloops/actions/workflows/codeql.yml">
+        <img alt="CodeQL Status" src="https://img.shields.io/github/actions/workflow/status/Bubu-Droid/bloops/codeql.yml?label=CodeQL&style=for-the-badge&logo=github&logoColor=c0caf5&labelColor=1a1b26&color=bb9af7" />
     </a>
 </div>
 
-<div align="center">
+<div align="center" style="height: 28px; display: flex; flex-wrap: wrap; justify-content: center; align-items: center; gap: 4px; margin: 6px 0;">
     <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>
@@ -88,7 +88,11 @@ for vector diagram rendering
 Install `bloops` from PyPI. Here is the
 [PyPI listing](https://pypi.org/project/bloops/).
 
-- I suggest using `uv`: run ```uv tool install bloops```.
+- I suggest using `uv`:
+  - Run `uv tool install bloops` if you'd like to use `bloops`
+  just as a CLI tool.
+  - Run `uv add bloops` if you you'd like to import `bloops`
+  as a package in your project.
 - Or, if you want to use `pip`: run `pip install bloops`.
 - AUR entry is yet to be added.
 
@@ -219,6 +223,14 @@ Here are reference tables for each BBCode tag bloops uses:
 
 </details>
 
+<details><summary>[hide]</summary>
+
+| Option  | Mandatory | Description                                         |
+| ------- | :-------: | --------------------------------------------------- |
+| `label` |    YES    | Label to be used as the summary for hidden details. |
+
+</details>
+
 <details><summary>math environments</summary>
 
 Currently, the following math box tags are supported:
@@ -238,6 +250,11 @@ proof and solutions.
 
 <details><summary>tags without any options</summary>
 
+| Tag                                | Purpose                                          |
+| ---------------------------------- | ------------------------------------------------ |
+| `[sidemark][/sidemark]`            | To put a number in the subscript for a sidenote. |
+| `[sidenote]<your-note>[/sidenote]` | To write a note to be put aside.                 |
+
 | Tag     | HTML Counterpart |
 | ------- | ---------------- |
 | `[b]`   | `<strong>`       |
@@ -259,9 +276,9 @@ proof and solutions.
 <br>
 
 An example showcasing the use of tags mentioned above has been
-provided in [example/content.bbcode](example/content.bbcode)
+provided in [example/content.bbcode][content.bbcode]
 and the corresponding generated HTML file is present in
-[example/index.html](example/index.html).
+[example/index.html][example.html].
 
 ## API Reference
 
@@ -277,11 +294,11 @@ If you want to convert a BBCode text into HTML using `bloops`,
 first run `validate_bbcode`, then `compile_asy_diagrams`, and
 finally `convert_bbcode_to_html` on the text.
 
-Bloops also provides the global constants under the `vars` module
-which provides `BBCODE_TAGS`, `STYLESHEET`, and `ERROR_TEMPLATE`.
+Bloops also provides the `BBCODE_TAGS` global constant
+under the `vars` module.
 
 A detailed documentation of these API endpoints can be found in
-[docs/API.md](docs/API.md).
+[docs/api.md][api.md].
 
 ## FAQs
 
@@ -331,7 +348,7 @@ need JS for running simple static pages.
 ## Contribution
 
 Contributions are very welcome!
-Please read [CONTRIBUTING.md](CONTRIBUTING.md) for a guide on
+Please read [CONTRIBUTING.md][CONTRIBUTING.md] for a guide on
 how to contribute. I'm against the idea of using AI
 for writing hobby projects; however, I have no
 problem if someone else uses them. If you're using AI assistance
@@ -346,11 +363,16 @@ how to implement it.
 ## TODOs
 
 - [ ] Implement a post-processor which adds paragraph tags around
-every disjoint block of HTML code.
-- [ ] Change `BBCODE_TAGS` to a dict instead of a list.
-- [ ] Handle `]` inside arguments of BBCode tags.
-- [ ] Add script placeholder to HTML templates.
-- [ ] De-couple templates and stylesheets by moving them
-to their independent files.
+  every disjoint block of HTML code.
+- [ ] Shift avatar to integration server.
+- [ ] Handle `[` or `]` inside arguments of BBCode tags.
+  (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.)
 
 <p align="right"><a href="#index">&uarr; Back to top</a></p>
+
+[content.bbcode]: https://github.com/Bubu-Droid/bloops/blob/main/example/content.bbcode
+[example.html]: https://github.com/Bubu-Droid/bloops/blob/main/example/index.html
+[api.md]: https://github.com/Bubu-Droid/bloops/blob/main/docs/api.md
+[CONTRIBUTING.md]: https://github.com/Bubu-Droid/bloops/blob/main/CONTRIBUTING.md

{bloops-0.0.2 → bloops-0.2.0}/example/content.bbcode

@@ -87,7 +87,9 @@ dot("$Y$", Y, NW,       tnMagenta);
 
 Here's a cute diagram from my
 [url link="https://aops.com/community/c6h3106748p32782057"]IMO 2023 G4[/url]
-solve.
+solve.[sidemark][/sidemark]
+
+[sidenote]One of my favorite problems ever. :)[/sidenote]
 
 [asy src=static/mewtwo.svg label=mewtwo width=80 caption="cute diagram from IMO 2023 P2"]
 import graph;
@@ -220,6 +222,8 @@ Prove that this process will eventually reach the number 1,
 regardless of which positive integer is chosen initially.
 [/lemma]
 
+[hide label="The proof is hidden inside this block."]
 [proof]
 [s]Left as an exercise to the reader[/s] Skipped, too easy.
 [/proof]
+[/hide]

{bloops-0.0.2 → bloops-0.2.0}/example/index.html

@@ -9,24 +9,25 @@
       type="image/x-icon"
       href="https://avatar.artofproblemsolving.com/avatar_778606.png"
     />
-    <link rel="stylesheet" href="static/style.css" />
-    <link rel="preconnect" href="https://fonts.googleapis.com" />
-    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
-    <link
-      href="https://fonts.googleapis.com/css2?family=Lora:ital,wght@0,400..700;1,400..700&display=swap"
-      rel="stylesheet"
-    />
-    <link
-      href="https://fonts.googleapis.com/css2?family=Open+Sans:ital,wght@0,300..800;1,300..800&display=swap"
-      rel="stylesheet"
-    />
     <link
-      href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:ital,wght@0,100..800;1,100..800&display=swap"
       rel="stylesheet"
+      href="https://cdn.jsdelivr.net/npm/@catppuccin/highlightjs@1.0.1/css/catppuccin-variables.css"
     />
+    <link rel="stylesheet" href="static/style.css" />
+    <script>
+      try {
+        document.documentElement.dataset.theme =
+          localStorage.getItem("theme") ||
+          (matchMedia("(prefers-color-scheme: dark)").matches
+            ? "night"
+            : "day");
+      } catch {}
+    </script>
+    <link rel="preconnect" href="https://fonts.googleapis.com" />
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
     <link
+      href="https://fonts.googleapis.com/css2?family=Literata:ital,opsz,wght@0,7..72,200..900;1,7..72,200..900&family=JetBrains+Mono:ital,wght@0,100..800;1,100..800&display=swap"
       rel="stylesheet"
-      href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.12.0/styles/tokyo-night-dark.min.css"
     />
     <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.12.0/highlight.min.js"></script>
     <script>
@@ -55,16 +56,13 @@
       defer
       src="https://cdn.jsdelivr.net/npm/mathjax@4/tex-svg.js"
     ></script>
+    <script src="static/script.js" defer></script>
   </head>
   <body>
     <h1>Page Heading</h1>
 
     Here is a <span style="color: #9ece6a">code</span> block:
-    <pre>
-<code class="language-python">
-print("hello world!")
-</code>
-</pre>
+    <pre><code class="language-python">print("hello world!")</code></pre>
 
     Here's an <strong>Asymptote</strong> diagram:
     <figure>
@@ -76,7 +74,9 @@ print("hello world!")
     <a href="https://aops.com/community/c6h3106748p32782057" target="_blank"
       >IMO 2023 G4</a
     >
-    solve.
+    solve.<span class="sidemark"></span>
+
+    <span class="sidenote">One of my favorite problems ever. :)</span>
 
     <figure>
       <img src="static/mewtwo.svg" style="width: 80%; height: auto" />
@@ -128,12 +128,15 @@ print("hello world!")
       which positive integer is chosen initially.
     </div>
 
-    <div>
-      <i class="proof">Proof.</i>
-      <s>Left as an exercise to the reader</s> Skipped, too easy.<span
-        class="qed"
-        >&#9633;</span
-      >
-    </div>
+    <details>
+      <summary>The proof is hidden inside this block.</summary>
+      <div>
+        <i class="proof">Proof.</i>
+        <s>Left as an exercise to the reader</s> Skipped, too easy.<span
+          class="qed"
+          >&#9633;</span
+        >
+      </div>
+    </details>
   </body>
 </html>

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

@@ -38,10 +38,10 @@ dependencies = [
   "livereload>=2.7.1",
   "watchdog>=6",
 ]
-urls.Documentation = "https://github.com/Bubu-Droid/bloops/blob/main/docs/API.md"
+urls.Documentation = "https://github.com/Bubu-Droid/bloops/blob/main/docs/api.md"
 urls.Issues = "https://github.com/Bubu-Droid/bloops/issues"
 urls.Repository = "https://github.com/Bubu-Droid/bloops"
-scripts.bloops = "bloops.__main__:main"
+scripts.bloops = "bloops.cli:main"
 
 [dependency-groups]
 dev = [
@@ -52,6 +52,7 @@ dev = [
 [tool.hatch]
 version.path = "src/bloops/__about__.py"
 build.targets.wheel.packages = [ "src/bloops" ]
+build.targets.sdist.include = [ "/src", "/tests", "/docs", "/example" ]
 
 [tool.ruff]
 line-length = 80

{bloops-0.0.2 → bloops-0.2.0}/src/bloops/__about__.py

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

bloops-0.2.0/src/bloops/__main__.py

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

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

@@ -8,6 +8,7 @@ server.
 import pathlib
 import threading
 import time
+from importlib.resources import files
 from typing import override
 
 from livereload import Server  # pyright: ignore[reportMissingTypeStubs]
@@ -20,7 +21,12 @@ from watchdog.observers import Observer
 
 from bloops.bloopser import convert_bbcode_to_html
 from bloops.validator import compile_asy_diagrams, validate_bbcode
-from bloops.vars import ERROR_TEMPLATE, STYLESHEET
+
+_static = files("bloops") / "static"
+
+ERROR_TEMPLATE = (_static / "error_template.html").read_text(encoding="utf-8")
+STYLESHEET = (_static / "style.css").read_text(encoding="utf-8")
+SCRIPT = (_static / "script.js").read_text(encoding="utf-8")
 
 
 class _Handler(PatternMatchingEventHandler):
@@ -72,8 +78,7 @@ class _Handler(PatternMatchingEventHandler):
             event: File system event describing the modification.
         """
 
-        with self.input_file.open(mode="r", encoding="utf-8") as f:
-            new_content = f.read().strip()
+        new_content = self.input_file.read_text(encoding="utf-8").strip()
         if self.file_content == new_content:
             return
         print("---------- File change detected ----------")
@@ -105,11 +110,11 @@ class _Handler(PatternMatchingEventHandler):
             )
 
             print("Converting BBCode into HTML...")
-            with self.output_file.open("w", encoding="utf-8") as f:
-                _ = f.write(convert_bbcode_to_html(self.file_content))
+            _ = self.output_file.write_text(
+                convert_bbcode_to_html(self.file_content), encoding="utf-8"
+            )
         except Exception:
-            with self.output_file.open("w", encoding="utf-8") as f:
-                _ = f.write(ERROR_TEMPLATE)
+            _ = self.output_file.write_text(ERROR_TEMPLATE, encoding="utf-8")
             # HACK: the liveserver plugin takes short time span before
             # it can reflect the updates.
             # if we raise the exception immediately, then the program
@@ -147,6 +152,8 @@ def main(
     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"
@@ -161,13 +168,12 @@ 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.")
-    with input_file.open(mode="r", encoding="utf-8") as f:
-        file_content = f.read().strip()
+    file_content = input_file.read_text(encoding="utf-8").strip()
     if not style_file.exists():
-        with style_file.open("w", encoding="utf-8") as f:
-            _ = f.write(STYLESHEET)
-    with asy_cache_file.open("w", encoding="utf-8") as f:
-        _ = f.write("{}")
+        _ = style_file.write_text(STYLESHEET, encoding="utf-8")
+    if not script_file.exists():
+        _ = script_file.write_text(SCRIPT, encoding="utf-8")
+    _ = asy_cache_file.write_text("{}", encoding="utf-8")
 
     handler = _Handler(in_dir, out_dir, file_content)