pymdownx-inline-blocks 0.1.0__tar.gz

pymdownx_inline_blocks-0.1.0/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,36 @@
+name: Publish Python 🐍 distributions 📦 to PyPI
+on:
+  push:
+    tags:
+      - "*"
+jobs:
+  build-n-publish:
+    runs-on: ubuntu-latest
+    name: Build and publish Python 🐍 distributions 📦 to PyPI
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pygments-shell-console
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+      - name: Set up Python 3.10
+        uses: actions/checkout@master
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v1
+        with:
+          python-version: "3.10"
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: >-
+          python -m
+          build
+          --sdist
+          --wheel
+          --outdir dist/
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pymdownx_inline_blocks-0.1.0/.gitignore

@@ -0,0 +1,165 @@
+# Tests generated site
+tests/site/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

pymdownx_inline_blocks-0.1.0/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.4
+Name: pymdownx-inline-blocks
+Version: 0.1.0
+Summary: A Python Markdown extension to add inline block elements based on PyMdown Extensions.
+Project-URL: Repository, https://github.com/joapuiib/pymdownx-inline-blocks
+Author-email: Joan Puigcerver <joapuiib@gmail.com>
+Maintainer-email: Joan Puigcerver <joapuiib@gmail.com>
+Requires-Python: >=3.5
+Requires-Dist: markdown>=3.4
+Requires-Dist: pymdown-extensions>=10.0

pymdownx_inline_blocks-0.1.0/README.md

@@ -0,0 +1,53 @@
+# PyMdown Inline Blocks
+A Python Markdown extension to convert inline block shorthand syntax into [PyMdown Block Extension][pymdownx-block] format
+
+[pymdownx-block]: https://facelessuser.github.io/pymdown-extensions/extensions/blocks/
+
+- Convert single-line inline block syntax into fully-formed block syntax.
+- Supports modifiers for advanced block formatting.
+- Simple and lightweight; integrates easily with Markdown or MkDocs.
+
+
+## Example
+The following markdown inline block syntax:
+
+```markdown
+![img](placeholder.png)
+/// attribution: Unknown author
+/// figure-caption | < ^1 : Caption
+```
+
+Will be converted to the following PyMdown Block syntax:
+
+```markdown
+![img](placeholder.png)
+/// attribution
+Unknown author
+///
+/// figure-caption | < ^1
+Caption
+///
+```
+
+
+## Installation
+Install the extension via pip:
+
+```bash
+pip install pymdownx-inline-blocks
+```
+
+
+## Usage
+To use the extension, add it to your Markdown or MkDocs configuration:
+
+```python
+md = markdown.Markdown(extensions=['inline_blocks'])
+```
+
+or, if using MkDocs, add it to your `mkdocs.yml`:
+
+```yaml
+markdown_extensions:
+  - inline_blocks
+```

pymdownx_inline_blocks-0.1.0/inline_blocks/__init__.py

@@ -0,0 +1,51 @@
+import re
+from markdown.extensions import Extension
+from markdown.preprocessors import Preprocessor
+
+
+class InlineBlockPreprocessor(Preprocessor):
+    # Match forms:
+    # 1. /// block: content
+    # 2. /// block | modifiers : content
+    RE = re.compile(
+        r'^(?P<slashes>/{3,})\s*'                 # Capture 3+ leading slashes
+        r'(?P<block>[a-zA-Z0-9_-]+)'             # Block type
+        r'(?:\s*\|\s*(?P<modifiers>[^:]+))?'     # Optional modifiers
+        r'\s*:\s*'
+        r'(?P<content>.+)$'                       # Content
+    )
+
+    def run(self, lines):
+        new_lines = []
+        for line in lines:
+            m = self.RE.match(line)
+            if m:
+                slashes = m.group("slashes")
+                block_type = m.group("block")
+                modifiers = m.group("modifiers")
+                content = m.group("content").strip()
+
+                if modifiers:
+                    new_lines.append(f"{slashes} {block_type} | {modifiers.strip()}")
+                else:
+                    new_lines.append(f"{slashes} {block_type}")
+                new_lines.append(content)
+                new_lines.append(slashes)
+            else:
+                new_lines.append(line)
+        return new_lines
+
+
+class InlineBlockExtension(Extension):
+    def extendMarkdown(self, md):
+        md.preprocessors.register(
+            InlineBlockPreprocessor(md),
+            "inline_blocks",
+            25,
+        )
+
+
+def makeExtension(*args, **kwargs):
+    """Return extension."""
+
+    return InlineBlockExtension(*args, **kwargs)

pymdownx_inline_blocks-0.1.0/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = 'pymdownx-inline-blocks'
+description = "A Python Markdown extension to add inline block elements based on PyMdown Extensions."
+# readme = {file = 'README.md', content-type='text/markdown'}
+version = '0.1.0'
+authors = [
+    {name = 'Joan Puigcerver', email = 'joapuiib@gmail.com'}
+]
+maintainers = [
+    {name = 'Joan Puigcerver', email = 'joapuiib@gmail.com'}
+]
+# license = {file = 'LICENSE'}
+requires-python = '>=3.5'
+dependencies = [
+    "markdown>=3.4",
+    "pymdown-extensions>=10.0"
+]
+
+[project.urls]
+# 'Homepage' = ''
+'Repository' = 'https://github.com/joapuiib/pymdownx-inline-blocks'
+# 'Issue Tracker' = ''
+
+[tool.hatch.build.targets.wheel]
+packages = ["."]
+

pymdownx_inline_blocks-0.1.0/tests/test_inline-blocks.py

@@ -0,0 +1,82 @@
+import markdown
+import pytest
+from inline_blocks import InlineBlockExtension
+
+md = markdown.Markdown(extensions=['inline_blocks'])
+
+
+def render(text: str) -> str:
+    # Preprocessors run before conversion to HTML.
+    return "\n".join(md.preprocessors['inline_blocks'].run(text.splitlines()))
+
+
+def test_simple_attribution():
+    input_text = "/// attribution: Unknown author"
+    expected = "\n".join([
+        "/// attribution",
+        "Unknown author",
+        "///"
+    ])
+    assert render(input_text) == expected
+
+
+def test_block_with_modifiers():
+    input_text = "/// figure-caption | < ^1 : Caption"
+    expected = "\n".join([
+        "/// figure-caption | < ^1",
+        "Caption",
+        "///"
+    ])
+    assert render(input_text) == expected
+
+
+def test_multiple_blocks_in_sequence():
+    input_text = "\n".join([
+        "![img](placeholder.png)",
+        "/// attribution: Unknown author",
+        "/// figure-caption | < ^1 : Caption",
+    ])
+    expected = "\n".join([
+        "![img](placeholder.png)",
+        "/// attribution",
+        "Unknown author",
+        "///",
+        "/// figure-caption | < ^1",
+        "Caption",
+        "///"
+    ])
+    assert render(input_text) == expected
+
+
+def test_non_matching_lines_pass_through():
+    input_text = "This is a normal line."
+    expected = "This is a normal line."
+    assert render(input_text) == expected
+
+
+def test_trims_extra_spaces():
+    input_text = "/// attribution:   Some author   "
+    expected = "\n".join([
+        "/// attribution",
+        "Some author",
+        "///"
+    ])
+    assert render(input_text) == expected
+
+
+@pytest.mark.parametrize("line", [
+    "///not-valid",   # missing space after ///
+    "/// block only", # no colon
+    "/// : no block", # no block type
+])
+def test_invalid_lines_remain_unchanged(line):
+    assert render(line) == line
+
+def test_more_slashes():
+    input_text = "///// attribution: Extra slashes"
+    expected = "\n".join([
+        "///// attribution",
+        "Extra slashes",
+        "/////"
+    ])
+    assert render(input_text) == expected