markdownizer 0.0.1__tar.gz

markdownizer-0.0.1/.editorconfig

@@ -0,0 +1,11 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+end_of_line = lf

markdownizer-0.0.1/.github/workflows/build.yml

@@ -0,0 +1,65 @@
+name: Build
+
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python_version: ['3.10', '3.11']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python_version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install hatch
+        hatch env create
+    - name: Lint and typecheck
+      run: |
+        hatch run lint-check
+    - name: Test
+      run: |
+        hatch run test-cov-xml
+    - uses: codecov/codecov-action@v3
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        fail_ci_if_error: true
+        verbose: true
+
+  release:
+    runs-on: ubuntu-latest
+    needs: test
+    if: startsWith(github.ref, 'refs/tags/')
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    - name: Install dependencies
+      shell: bash
+      run: |
+        python -m pip install --upgrade pip
+        pip install hatch
+    - name: Build and publish on PyPI
+      env:
+        HATCH_INDEX_USER: ${{ secrets.HATCH_INDEX_USER }}
+        HATCH_INDEX_AUTH: ${{ secrets.HATCH_INDEX_AUTH }}
+      run: |
+        hatch build
+        hatch publish
+    - name: Create release
+      uses: ncipollo/release-action@v1
+      with:
+        draft: true
+        body: ${{ github.event.head_commit.message }}
+        artifacts: dist/*.whl,dist/*.tar.gz
+        token: ${{ secrets.GITHUB_TOKEN }}

markdownizer-0.0.1/.github/workflows/documentation.yml

@@ -0,0 +1,56 @@
+name: Build documentation
+
+on:
+  push:
+    branches:
+      - main
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+# Default to bash
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install hatch
+        hatch env create
+    - name: Build
+      run: hatch run docs-build
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v1
+      with:
+        path: ./site
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

markdownizer-0.0.1/.gitignore

@@ -0,0 +1,111 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# 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/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+junit/
+junit.xml
+test.db
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# .vscode
+.vscode/
+
+# OS files
+.DS_Store

markdownizer-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,53 @@
+default_language_version:
+    python: python3.10
+default_stages: [commit]
+repos:
+- repo: local
+  hooks:
+    - id: pytest-check
+      name: pytest-check
+      entry: poetry run pytest
+      language: system
+      # stages: [push]
+      types: [python]
+      pass_filenames: false
+      always_run: true
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+    # - id: trailing-whitespace
+    # - id: check-ast
+    - id: check-case-conflict
+    - id: check-docstring-first
+    - id: check-merge-conflict
+    # - id: check-yaml
+    - id: check-toml
+    - id: check-json
+    - id: detect-private-key
+    - id: forbid-new-submodules
+    # - id: check-added-large-files
+# https://pre-commit.com/hooks.html
+- repo: https://github.com/commitizen-tools/commitizen
+  rev: 3.5.2
+  hooks:
+    - id: commitizen
+      stages: [commit-msg]
+      additional_dependencies: [typing-extensions] # cz-github-convention]
+- repo: https://github.com/ambv/black
+  rev: 23.7.0
+  hooks:
+    - id: black
+      args: [--preview]
+
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.4.1
+  hooks:
+    - id: mypy
+      # args: [--ignore-missing-imports]
+      additional_dependencies: [pyside6, types-Deprecated, types-docutils, types-orjson, types-toml,  types-typed-ast, types-requests, types-python-dateutil]
+      exclude: '(sciscintilla)\.py'
+
+- repo: https://github.com/charliermarsh/ruff-pre-commit
+  rev: v0.0.278
+  hooks:
+    - id: ruff

markdownizer-0.0.1/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023, Philipp Temminghoff
+
+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.
+

markdownizer-0.0.1/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.1
+Name: markdownizer
+Version: 0.0.1
+Summary: Generate docs with ease.
+Project-URL: Documentation, https://phil65.github.io/markdownizer/
+Project-URL: Source, https://github.com/phil65/markdownizer
+Author-email: markdownizer <philipptemminghoff@gmail.com>
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# Markdownizer
+
+<p align="center">
+    <em>Generate docs with ease.</em>
+</p>
+
+[![build](https://github.com/phil65/markdownizer/workflows/Build/badge.svg)](https://github.com/phil65/markdownizer/actions)
+[![codecov](https://codecov.io/gh/phil65/markdownizer/branch/master/graph/badge.svg)](https://codecov.io/gh/phil65/markdownizer)
+[![PyPI version](https://badge.fury.io/py/markdownizer.svg)](https://badge.fury.io/py/markdownizer)
+
+---
+
+**Documentation**: <a href="https://phil65.github.io/markdownizer/" target="_blank">https://phil65.github.io/markdownizer/</a>
+
+**Source Code**: <a href="https://github.com/phil65/markdownizer" target="_blank">https://github.com/phil65/markdownizer</a>
+
+---
+
+## Development
+
+### Setup environment
+
+We use [Hatch](https://hatch.pypa.io/latest/install/) to manage the development environment and production build. Ensure it's installed on your system.
+
+### Run unit tests
+
+You can run all the tests with:
+
+```bash
+hatch run test
+```
+
+### Format the code
+
+Execute the following command to apply linting and check typing:
+
+```bash
+hatch run lint
+```
+
+### Publish a new version
+
+You can bump the version, create a commit and associated tag with one command:
+
+```bash
+hatch version patch
+```
+
+```bash
+hatch version minor
+```
+
+```bash
+hatch version major
+```
+
+Your default Git text editor will open so you can add information about the release.
+
+When you push the tag on GitHub, the workflow will automatically publish it on PyPi and a GitHub release will be created as draft.
+
+## Serve the documentation
+
+You can serve the Mkdocs documentation with:
+
+```bash
+hatch run docs-serve
+```
+
+It'll automatically watch for changes in your code.
+
+## License
+
+This project is licensed under the terms of the MIT license.

markdownizer-0.0.1/README.md

@@ -0,0 +1,73 @@
+# Markdownizer
+
+<p align="center">
+    <em>Generate docs with ease.</em>
+</p>
+
+[![build](https://github.com/phil65/markdownizer/workflows/Build/badge.svg)](https://github.com/phil65/markdownizer/actions)
+[![codecov](https://codecov.io/gh/phil65/markdownizer/branch/master/graph/badge.svg)](https://codecov.io/gh/phil65/markdownizer)
+[![PyPI version](https://badge.fury.io/py/markdownizer.svg)](https://badge.fury.io/py/markdownizer)
+
+---
+
+**Documentation**: <a href="https://phil65.github.io/markdownizer/" target="_blank">https://phil65.github.io/markdownizer/</a>
+
+**Source Code**: <a href="https://github.com/phil65/markdownizer" target="_blank">https://github.com/phil65/markdownizer</a>
+
+---
+
+## Development
+
+### Setup environment
+
+We use [Hatch](https://hatch.pypa.io/latest/install/) to manage the development environment and production build. Ensure it's installed on your system.
+
+### Run unit tests
+
+You can run all the tests with:
+
+```bash
+hatch run test
+```
+
+### Format the code
+
+Execute the following command to apply linting and check typing:
+
+```bash
+hatch run lint
+```
+
+### Publish a new version
+
+You can bump the version, create a commit and associated tag with one command:
+
+```bash
+hatch version patch
+```
+
+```bash
+hatch version minor
+```
+
+```bash
+hatch version major
+```
+
+Your default Git text editor will open so you can add information about the release.
+
+When you push the tag on GitHub, the workflow will automatically publish it on PyPi and a GitHub release will be created as draft.
+
+## Serve the documentation
+
+You can serve the Mkdocs documentation with:
+
+```bash
+hatch run docs-serve
+```
+
+It'll automatically watch for changes in your code.
+
+## License
+
+This project is licensed under the terms of the MIT license.

markdownizer-0.0.1/__linkreplacer/__init__.py

@@ -0,0 +1,3 @@
+from .linkreplacer import LinkReplacerPlugin
+
+__all__ = ["LinkReplacerPlugin"]

markdownizer-0.0.1/__linkreplacer/linkreplacer.py

@@ -0,0 +1,73 @@
+from __future__ import annotations
+
+import collections
+import logging
+import os
+import pathlib
+import re
+import urllib.parse
+
+from mkdocs.plugins import BasePlugin
+import mkdocs.utils
+
+
+logger = logging.getLogger(f"mkdocs.plugins.{__name__}")
+logger.addFilter(mkdocs.utils.warning_filter)
+
+# For Regex, match groups are:
+#       0: Whole markdown link e.g. [Alt-text](url)
+#       1: Alt text
+#       2: Full URL e.g. url + hash anchor
+#       3: Filename e.g. filename.md
+#       4: File extension e.g. .md, .png, etc.
+#       5. hash anchor e.g. #my-sub-heading-link
+AUTOLINK_RE = r"\[([^\]]+)\]\((([^)/]+\.(md|png|jpg))(#.*)*)\)"
+
+
+class AutoLinkReplacerPlugin:
+    def __init__(self, base_docs_url, page_url, mapping):
+        self.mapping = mapping
+        self.page_url = page_url
+        self.base_docs_url = pathlib.Path(base_docs_url)
+        # Absolute URL of the linker
+        self.linker_url = os.path.dirname(self.base_docs_url / page_url)  # noqa: PTH120
+
+    def __call__(self, match):
+        # Name of the markdown file
+        filename = urllib.parse.unquote(match.group(3).strip())
+        if filename not in self.mapping:
+            return f"`{match.group(3).replace('.md', '')}`"
+        filenames = self.mapping[filename]
+        if len(filenames) > 1:
+            logger.warning(
+                f"{self.page_url}: {match.group(3)} has multiple targets: {filenames}"
+            )
+        abs_link_url = (self.base_docs_url / self.mapping[filename][0]).parent
+        # need os.replath here bc pathlib.relative_to throws an exception
+        # when linking across drives
+        rel_path = os.path.relpath(abs_link_url, self.linker_url)
+        # html_filename = filename.replace(".md", ".html")
+        rel_link_url = os.path.join(rel_path, filename)  # noqa: PTH118
+        new_text = (
+            match.group(0).replace(match.group(2), rel_link_url)
+            if match.group(5) is None
+            else match.group(0).replace(match.group(2), rel_link_url + match.group(5))
+        )
+        new_text = new_text.replace("\\", "/")
+        logger.debug(
+            f"LinkReplacer: {self.page_url}: {match.group(3)=} -> {rel_link_url=}"
+        )
+        return new_text
+
+
+class LinkReplacerPlugin(BasePlugin):
+    def on_page_markdown(self, markdown, page, config, files, **kwargs):
+        base_docs_url = config["docs_dir"]
+        page_url = page.file.src_path
+        mapping = collections.defaultdict(list)
+        for file_ in files:
+            filename = os.path.basename(file_.abs_src_path)  # noqa: PTH119
+            mapping[filename].append(file_.url)
+        plugin = AutoLinkReplacerPlugin(base_docs_url, page_url, mapping)
+        markdown = re.sub(AUTOLINK_RE, plugin, markdown)
+        return markdown

markdownizer-0.0.1/docs/SUMMARY.md

@@ -0,0 +1 @@
+* [markdownizer](SUMMARY.md)

markdownizer-0.0.1/docs/gen_pages.py

@@ -0,0 +1,31 @@
+"""Generate the code reference pages and navigation."""
+
+
+from __future__ import annotations
+
+import logging
+import sys
+
+import markdownizer
+import mkdocs
+from markdownizer import classhelpers
+
+logger = logging.getLogger(__name__)
+
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
+
+docs = markdownizer.Docs(module=markdownizer)
+nav = docs.create_nav(section="markdownizer")
+# na2 = docs.create_nav(section="test")
+
+nav[("overview",)] = "index.md"
+# na2[("overview",)] = "index.md"
+
+for klass in docs.iter_classes_for_module("markdownizer"):
+    nav.add_class_page(klass=klass, path=f"{klass.__name__}.md")
+
+# nav.pretty_print()
+print(str(docs))
+
+# nav.write()
+docs.write()

markdownizer-0.0.1/docs/index.md

@@ -0,0 +1 @@
+--8<-- "README.md"

markdownizer-0.0.1/docs/markdownizer/Admonition.md

@@ -0,0 +1,21 @@
+## DocStrings
+
+::: markdownizer..Admonition
+
+
+
+
+## Inheritance diagram
+
+```mermaid
+graph TD
+  object
+  BaseNode
+  BaseSection
+  Text
+  Admonition
+  BaseNode --> BaseSection
+  Text --> Admonition
+  BaseSection --> Text
+  object --> BaseNode
+```

markdownizer-0.0.1/docs/markdownizer/BaseSection.md

@@ -0,0 +1,29 @@
+## DocStrings
+
+::: markdownizer..BaseSection
+
+
+
+
+## Child classes
+
+|Class|Module|Description|
+|--|----|--|
+|[Text](Text.md)|markdownizer.basesection|Class for any Markup text.|
+|[Document](Document.md)|markdownizer.document||
+|[Image](Image.md)|markdownizer.image||
+|[List](List.md)|markdownizer.list||
+|[Table](Table.md)|markdownizer.table||
+|[Nav](Nav.md)|markdownizer.nav||
+
+
+## Inheritance diagram
+
+```mermaid
+graph TD
+  BaseSection
+  BaseNode
+  object
+  BaseNode --> BaseSection
+  object --> BaseNode
+```

markdownizer-0.0.1/docs/markdownizer/BinaryImage.md

@@ -0,0 +1,21 @@
+## DocStrings
+
+::: markdownizer..BinaryImage
+
+
+
+
+## Inheritance diagram
+
+```mermaid
+graph TD
+  object
+  BinaryImage
+  BaseNode
+  BaseSection
+  Image
+  BaseNode --> BaseSection
+  Image --> BinaryImage
+  BaseSection --> Image
+  object --> BaseNode
+```

markdownizer-0.0.1/docs/markdownizer/ClassDocument.md

@@ -0,0 +1,21 @@
+## DocStrings
+
+::: markdownizer..ClassDocument
+
+
+
+
+## Inheritance diagram
+
+```mermaid
+graph TD
+  ClassDocument
+  object
+  Document
+  BaseNode
+  BaseSection
+  BaseNode --> BaseSection
+  BaseSection --> Document
+  Document --> ClassDocument
+  object --> BaseNode
+```