obsitex 0.0.5__py3-none-any.whl → 0.0.6__py3-none-any.whl

obsitex/parser/__init__.py

@@ -1,6 +1,6 @@
 import logging
 from pathlib import Path
-from typing import Optional, Sequence
+from typing import Optional, Sequence, Type
 
 import bibtexparser
 from jinja2 import Environment
@@ -39,6 +39,8 @@ class ObsidianParser:
         appendix_marker: str = DEFAULT_APPENDIX_MARKER,
         bibliography_marker: str = DEFAULT_BIBLIOGRAPHY_MARKER,
         base_hlevel: int = 0,
+        custom_blocks: Sequence[Type[LaTeXBlock]] = [],
+        default_parseable_blocks: Sequence[Type[LaTeXBlock]] = PARSEABLE_BLOCKS,
     ):
         self.job_template = job_template
         self.main_template = main_template
@@ -46,6 +48,7 @@ class ObsidianParser:
         self.appendix_marker = appendix_marker
         self.bibliography_marker = bibliography_marker
         self.out_bitex_path = out_bitex_path
+        self.parseable_blocks = custom_blocks + default_parseable_blocks
 
         # Construct an execution plan, which will collect the jobs to run from
         # the files and pths provided
@@ -154,7 +157,7 @@ class ObsidianParser:
         while curr_i < len(lines):
             found_block = False
 
-            for block_class in PARSEABLE_BLOCKS:
+            for block_class in self.parseable_blocks:
                 block_instance = block_class.detect_block(lines, curr_i)
 
                 if block_instance is not None:

obsitex/parser/blocks.py

@@ -442,50 +442,63 @@ class Figure(AbstractCallout):
         return AbstractCallout.detect_block(lines, index, "figure", Figure)
 
 
-class RawLaTeXBlock(LaTeXBlock):
-    def __init__(self, content):
-        super().__init__(content, in_latex=True)
+class AbstractCodeBlock(LaTeXBlock):
+    def __init__(self, content: str, language: str, in_latex: bool = True):
+        super().__init__(content, in_latex=in_latex)
+        self.language = language
+
+    def __repr__(self):
+        return f'{self.__class__.__name__}(content="{self.content}", language="{self.language}")'
 
     @staticmethod
     def detect_block(
-        lines: Sequence[str], index: int
+        lines: Sequence[str],
+        index: int,
+        language: str,
+        instance_class: Type["LaTeXBlock"],
     ) -> Optional[Tuple["LaTeXBlock", int]]:
-        if lines[index].startswith("```latex"):
+        if lines[index].startswith(f"```{language}"):
             end_index = find_next_index(
                 lines, lambda line: line.startswith("```"), index + 1
             )
             raw_lines = lines[index + 1 : end_index]
-            return RawLaTeXBlock(raw_lines), end_index
+            return instance_class("\n".join(raw_lines), language), end_index
 
         return None
 
 
-class TikZBlock(LaTeXBlock):
-    def __init__(self, content):
-        super().__init__(content, in_latex=True)
-
+class RawLaTeXBlock(AbstractCodeBlock):
     @staticmethod
     def detect_block(
         lines: Sequence[str], index: int
     ) -> Optional[Tuple["LaTeXBlock", int]]:
-        if lines[index].startswith("```tikz"):
-            end_index = find_next_index(
-                lines, lambda line: line.startswith("```"), index + 1
-            )
-            raw_lines = lines[index + 1 : end_index]
-            tikz_content = "\n".join(raw_lines)
+        return AbstractCodeBlock.detect_block(lines, index, "latex", RawLaTeXBlock)
 
-            # Remove tikz directive that are necessary to render in obsidian
-            tikz_content = tikz_content.replace("\\begin{document}", "")
-            tikz_content = tikz_content.replace("\\end{document}", "")
 
-            # Filter out any sort of usepackage
-            tikz_content = re.sub(r"\\usepackage.*\n", "", tikz_content)
-            tikz_content = re.sub(r"\\usetikzlibrary.*\n", "", tikz_content)
+class TikZBlock(AbstractCodeBlock):
+    def formatted_text(self, **kwargs):
+        self.content = self.content.replace("\\begin{document}", "")
+        self.content = self.content.replace("\\end{document}", "")
+        self.content = re.sub(r"\\usepackage.*\n", "", self.content)
+        self.content = re.sub(r"\\usetikzlibrary.*\n", "", self.content)
+        return super().formatted_text(**kwargs)
 
-            return TikZBlock(tikz_content), end_index
+    @staticmethod
+    def detect_block(
+        lines: Sequence[str], index: int
+    ) -> Optional[Tuple["LaTeXBlock", int]]:
+        return AbstractCodeBlock.detect_block(lines, index, "tikz", TikZBlock)
 
-        return None
+
+class PythonBlock(AbstractCodeBlock):
+    def formatted_text(self, **kwargs):
+        return f"\\begin{{lstlisting}}[language=Python,breaklines=true]\n{self.content}\n\\end{{lstlisting}}\n"
+
+    @staticmethod
+    def detect_block(
+        lines: Sequence[str], index: int
+    ) -> Optional[Tuple["LaTeXBlock", int]]:
+        return AbstractCodeBlock.detect_block(lines, index, "python", PythonBlock)
 
 
 PARSEABLE_BLOCKS: Sequence[Type[LaTeXBlock]] = [
@@ -498,4 +511,5 @@ PARSEABLE_BLOCKS: Sequence[Type[LaTeXBlock]] = [
     Figure,
     RawLaTeXBlock,
     TikZBlock,
+    PythonBlock,
 ]

obsitex-0.0.6.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Rui Reis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{obsitex-0.0.5.dist-info → obsitex-0.0.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: obsitex
-Version: 0.0.5
+Version: 0.0.6
 Summary: A Python package to convert Obsidian Markdown files and folders into structured LaTeX documents.
 Home-page: UNKNOWN
 Author: Rui Reis
@@ -30,6 +30,23 @@ ObsiTex is a Python package that automates the conversion of Obsidian Markdown f
 - Uses **Jinja2 templates**, allowing full customization of the LaTeX output.
 
 
+## Table of Contents
+
+- [Quick Start](#quick-start)
+- [Supported Elements](#supported-elements)
+  - [Citations](#citations)
+  - [Callouts](#callouts)
+    - [Figure](#figure)
+    - [Table](#table)
+    - [Styling](#styling)
+- [Samples](#samples)
+  - [Single File - Motivation Letter](#single-file---motivation-letter-for-willy-wonkas-chocolate-factory)
+  - [Single File - Research Paper on Socks](#single-file---research-paper-on-socks)
+  - [Folder - MSc Thesis on Ducks](#folder---msc-thesis-on-ducks)
+  - [Bring Your Own Blocks](#bring-your-own-blocks)
+- [Acknowledgments](#acknowledgments)
+- [License](#license)
+
 ## Quick Start
 
 To install ObsiTex, use pip:
@@ -233,6 +250,17 @@ obsitex --input obsidian-folder \
 - [main.bib](https://github.com/ruipreis/obsitex/tree/main/samples/msc-dissertation/output/main.bib)
 - [main.pdf](https://github.com/ruipreis/obsitex/tree/main/samples/msc-dissertation/output/main.pdf)
 
+### Bring Your Own Blocks
+
+Learn how to create parsers for custom blocks in the `samples/byob` folder. This will allow you to add custom blocks to the parser, and thus customize the LaTeX output to your needs.
+
+This example adds support for line breaks and warnings in the LaTeX output, by creating custom blocks for these elements.
+
+#### Output Files
+
+- [main.tex](https://github.com/ruipreis/obsitex/tree/main/samples/byob/output/main.tex)
+- [main.pdf](https://github.com/ruipreis/obsitex/tree/main/samples/byob/output/main.pdf)
+
 ## Acknowledgments
 
 This work was inspired by:

{obsitex-0.0.5.dist-info → obsitex-0.0.6.dist-info}/RECORD

@@ -2,14 +2,15 @@ obsitex/__init__.py,sha256=w-YmpYAdbQPyJqO1JLEaRApy1M_FzAH7nN4VvlQku-U,42
 obsitex/cli.py,sha256=otjRQIoidXecJFQs6WCPFRUv8njgieEULQzJfMZMLYY,2797
 obsitex/constants.py,sha256=dgMZjokPOYHLLOvDbsOM4XiQvOK26BAHmRdeWHn8DTE,970
 obsitex/utils.py,sha256=hqLRvuaQx_Y5rVY8B8lD6rbkMagoc3MBtswwdt_34f0,481
-obsitex/parser/__init__.py,sha256=FPcfq6MaVpxyrhrdfWRVNSzdE9Gz9DUOh_DPlahYsEc,7494
-obsitex/parser/blocks.py,sha256=q7LJcctsM32sh5iR5Bp5aa2e1kLucRwT4IGnlEsqOyA,15525
+obsitex/parser/__init__.py,sha256=EgJHjIjc2fg-VyAgYf63iAbV5wIsxUSYixWyTpl0WHE,7715
+obsitex/parser/blocks.py,sha256=PZv9cjmMXQzQNHHO1Lzm-qk2Gr6m-ULHNiGqewCcqyA,16107
 obsitex/parser/formatting.py,sha256=kfb_7PbdbW1QwE4HDbFrxkINejTOzwZqilgY1JCEZVE,4204
 obsitex/planner/__init__.py,sha256=4yf4scYeQ_jNO6nQZ0BboyILoA7su0LOe0KIrnCzn6U,9207
 obsitex/planner/jobs.py,sha256=UOnGMBlQFWy2nl7Zo_LcwNUiN9eqmdmhu8KeJnKWDjI,882
 obsitex/planner/links.py,sha256=SJqnJzyg2EtiZgtfZhzVBpqTVUSy87YZRObgltDv10M,1045
-obsitex-0.0.5.dist-info/METADATA,sha256=JsYOJA8coBOspeg28p_ac-B6hW5_9EPFir2wm9K8CNo,9189
-obsitex-0.0.5.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-obsitex-0.0.5.dist-info/entry_points.txt,sha256=TuUDmSt5DcUZCojJvpfweHX4Be9DKms74KOOdvRj7J0,46
-obsitex-0.0.5.dist-info/top_level.txt,sha256=Mi24FWCjxDXVa3wNtCN0NuT_dRgyN5haGA4IE8oHeLQ,8
-obsitex-0.0.5.dist-info/RECORD,,
+obsitex-0.0.6.dist-info/LICENSE,sha256=pVQkEXo8dC1gbK-5Qpmr2ZjHzb2ShD0Ppu4of962VfE,1065
+obsitex-0.0.6.dist-info/METADATA,sha256=l8H1U8nee4cujZ2ly_YNbqK_shLhD2geJhzcWUXM8oU,10335
+obsitex-0.0.6.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+obsitex-0.0.6.dist-info/entry_points.txt,sha256=TuUDmSt5DcUZCojJvpfweHX4Be9DKms74KOOdvRj7J0,46
+obsitex-0.0.6.dist-info/top_level.txt,sha256=Mi24FWCjxDXVa3wNtCN0NuT_dRgyN5haGA4IE8oHeLQ,8
+obsitex-0.0.6.dist-info/RECORD,,