mkdocs-data-plugin 0.1.0__tar.gz

mkdocs_data_plugin-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/

mkdocs_data_plugin-0.1.0/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.3
+Name: mkdocs-data-plugin
+Version: 0.1.0
+Summary: MkDocs plugin that allows to read data from markup files
+Project-URL: Documentation, https://joapuiib.github.io/mkdocs-data-plugin
+Project-URL: Download, https://github.com/joapuiib/mkdocs-data-plugin/releases
+Project-URL: Homepage, https://joapuiib.github.io/mkdocs-data-plugin
+Project-URL: Source, https://github.com/joapuiib/mkdocs-data-plugin
+Project-URL: Tracker, https://github.com/joapuiib/mkdocs-data-plugin/issues
+Author-email: Joan Puigcerver <joapuiib@gmail.com>
+License: MIT
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Requires-Dist: mkdocs-macros-plugin>=1.2.0
+Requires-Dist: mkdocs>=1.5.2
+Description-Content-Type: text/markdown
+
+# mkdocs-data-plugin
+MkDocs plugin that allows to read data from markup files
+
+Currently supported formats:
+
+- JSON
+- YAML
+
+## Documentation
+This plugin documentation can be found here: https://joapuiib.github.io/mkdocs-data-plugin/
+
+## Installation
+This plugin can be installed via pip:
+
+```bash
+pip install mkdocs-data-plugin
+```
+
+## Configuration
+Activate the plugin in your `mkdocs.yml`:
+
+```yaml
+plugins:
+  - data
+```

mkdocs_data_plugin-0.1.0/README.md

@@ -0,0 +1,25 @@
+# mkdocs-data-plugin
+MkDocs plugin that allows to read data from markup files
+
+Currently supported formats:
+
+- JSON
+- YAML
+
+## Documentation
+This plugin documentation can be found here: https://joapuiib.github.io/mkdocs-data-plugin/
+
+## Installation
+This plugin can be installed via pip:
+
+```bash
+pip install mkdocs-data-plugin
+```
+
+## Configuration
+Activate the plugin in your `mkdocs.yml`:
+
+```yaml
+plugins:
+  - data
+```

mkdocs_data_plugin-0.1.0/mkdocs_data_plugin/__init__.py

@@ -0,0 +1,2 @@
+version = "0.1.0"
+__version__ = "0.1.0"

mkdocs_data_plugin-0.1.0/mkdocs_data_plugin/plugin.py

@@ -0,0 +1,78 @@
+import os
+import yaml
+import json
+
+
+from mkdocs.config.defaults import MkDocsConfig
+from mkdocs.config import base, config_options as c
+from mkdocs.plugins import BasePlugin, get_plugin_logger
+
+log = get_plugin_logger(__name__)
+
+class DataPluginConfig(base.Config):
+    data_dir = c.Type(str, default='data')
+
+
+class DataPlugin(BasePlugin[DataPluginConfig]):
+    def __init__(self):
+        self.data = {}
+        self.processors = {
+            '.yml': yaml.safe_load,
+            '.yaml': yaml.safe_load,
+            '.json': json.load
+        }
+
+
+    def set_data(self, keys, value):
+        """
+        Set a value in the data attribute.
+        """
+        data = self.data
+        for key in keys[:-1]:
+            data = data.setdefault(key, {})
+        data[keys[-1]] = value
+
+
+    def on_config(self, config: MkDocsConfig):
+        self.load_data(self.config.data_dir)
+
+        macros_plugin = config.plugins.get('macros')
+        if macros_plugin:
+            macros_plugin.register_variables({'data': self.data})
+        else:
+            log.warning("The macros plugin is not installed. The `data` variable won't be available in pages.")
+
+
+    def load_data(self, path: str):
+        """
+        Iterate over all files in the data directory
+        and load them into the data attribute.
+        """
+        for root, _, files in os.walk(path):
+
+            keys = []
+            if root != self.config.data_dir:
+                directory = os.path.relpath(root, self.config.data_dir)
+                keys = directory.split(os.sep)
+
+            for file in files:
+                value = self.load_file(os.path.join(root, file))
+
+                filename, _ = os.path.splitext(file)
+                self.set_data(keys + [filename], value)
+
+
+    def load_file(self, path: str):
+        """
+        Load a file and return its content.
+        """
+        _, extension = os.path.splitext(path)
+        with open(path, 'r') as file:
+            return self.processors[extension](file)
+
+
+
+    def on_page_context(self, context, page, config, nav):
+        context['data'] = self.data
+        return context
+

mkdocs_data_plugin-0.1.0/pyproject.toml

@@ -0,0 +1,106 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "mkdocs-data-plugin"
+dynamic = ["version"]
+description = "MkDocs plugin that allows to read data from markup files"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.8"
+authors = [
+    { name = "Joan Puigcerver", email = "joapuiib@gmail.com" },
+]
+classifiers = [
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "mkdocs>=1.5.2",
+    "mkdocs-macros-plugin>=1.2.0",
+]
+
+[project.entry-points."mkdocs.plugins"]
+data = "mkdocs_data_plugin.plugin:DataPlugin"
+
+[project.urls]
+Documentation = "https://joapuiib.github.io/mkdocs-data-plugin"
+Download = "https://github.com/joapuiib/mkdocs-data-plugin/releases"
+Homepage = "https://joapuiib.github.io/mkdocs-data-plugin"
+Source = "https://github.com/joapuiib/mkdocs-data-plugin"
+Tracker = "https://github.com/joapuiib/mkdocs-data-plugin/issues"
+
+[tool.hatch.version]
+path = "mkdocs_data_plugin/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/mkdocs_data_plugin",
+    "/tests",
+]
+[tool.hatch.build.targets.wheel]
+exclude = ["/tests"]
+
+[tool.hatch.envs.default.scripts]
+all = [
+    "hatch run test:test",
+    "hatch run style:check",
+]
+
+[tool.hatch.envs.test]
+dependencies = [
+    "pytest",
+]
+
+[tool.hatch.envs.test.scripts]
+test = [
+    "pytest -xs",
+]
+
+[[tool.hatch.envs.test.matrix]]
+python = ["3.8", "3.9", "3.10", "3.11", "3.12"]
+type = ["default"]
+
+[tool.hatch.envs.doc]
+dependencies = [
+    "mkdocs-material>=9.2.5"
+]
+
+[tool.hatch.envs.doc.scripts]
+serve = [
+    "mkdocs serve",
+]
+
+[tool.hatch.envs.style]
+detached = true
+dependencies = [
+    "black",
+    "isort",
+    "ruff",
+]
+
+[tool.hatch.envs.style.scripts]
+check = [
+    "isort --check-only --diff mkdocs_static_i18n",
+    "black -q --check --diff mkdocs_static_i18n",
+    "ruff check mkdocs_static_i18n",
+]
+format = [
+    "isort -q mkdocs_static_i18n",
+    "black -q mkdocs_static_i18n",
+]
+
+[tool.black]
+line-length = 100
+target-version = ["py311"]
+skip-string-normalization = true
+
+[tool.isort]
+profile = "black"
+line_length = 100
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+ignore = ["E501"]

mkdocs_data_plugin-0.1.0/tests/data/a.yml

@@ -0,0 +1,2 @@
+a1: 1
+a2: text

mkdocs_data_plugin-0.1.0/tests/data/dir1/b.yml

@@ -0,0 +1,2 @@
+b1: 2
+b2: text

mkdocs_data_plugin-0.1.0/tests/data/dir2/c.json

@@ -0,0 +1,4 @@
+{
+  "c1": 3,
+  "c2": "text"
+}

mkdocs_data_plugin-0.1.0/tests/docs/test_data_template.md

@@ -0,0 +1,11 @@
+---
+title: "Test Data Template"
+---
+
+- data.a: `{{ data.a }}`
+- data.a.a1: `{{ data.a.a1 }}`
+- data.a.a2: `{{ data.a.a2 }}`
+- data.dir1.b.b1: `{{ data.dir1.b.b1 }}`
+- data.dir1.b.b2: `{{ data.dir1.b.b2 }}`
+- data.dir2.c.c1: `{{ data.dir2.c.c1 }}`
+- data.dir2.c.c2: `{{ data.dir2.c.c2 }}`

mkdocs_data_plugin-0.1.0/tests/mkdocs.yml

@@ -0,0 +1,2 @@
+site_name: MkDocs static i18n plugin tests
+site_url: http://localhost

mkdocs_data_plugin-0.1.0/tests/test_config.py

@@ -0,0 +1,15 @@
+from mkdocs.config.base import load_config
+
+from mkdocs_data_plugin.plugin import DataPlugin
+
+
+def test_config_default_values():
+    plugin = DataPlugin()
+    plugin.load_config({})
+    assert plugin.config.data_dir == 'data'
+
+
+def test_config_data_dir():
+    plugin = DataPlugin()
+    plugin.load_config({'data_dir': 'other_data'})
+    assert plugin.config.data_dir == 'other_data'

mkdocs_data_plugin-0.1.0/tests/test_data_template.py

@@ -0,0 +1,31 @@
+import re
+
+from mkdocs.commands.build import build
+from mkdocs.config.base import load_config
+
+
+def test_loads_files():
+    mkdocs_config = load_config(
+        "tests/mkdocs.yml",
+        plugins={
+            "macros": {},
+            "data": {'data_dir': 'tests/data'},
+        },
+    )
+
+    build(mkdocs_config)
+    site_dir = mkdocs_config["site_dir"]
+
+    with open(site_dir+'/test_data_template/index.html') as f:
+        data_loaded = re.findall(r"<code>([^<]*)", f.read())
+        print(data_loaded)
+        assert(data_loaded == [
+            "{'a1': 1, 'a2': 'text'}", # data/a.yml
+            "1", # data/a.yml -> a1
+            "text", # data/a.yml -> a2
+            "2", # data/dir1/b.yml -> b1
+            "text", # data/dir1/b.yml -> b2
+            "3", # data/dir2/c.yml -> c1
+            "text", # data/dir2/c.yml -> c2
+        ])
+

mkdocs_data_plugin-0.1.0/tests/test_load_data.py

@@ -0,0 +1,51 @@
+from mkdocs.commands.build import build
+from mkdocs.config.base import load_config
+
+
+def test_empty_data_is_empty_dict():
+    mkdocs_config = load_config(
+        "tests/mkdocs.yml",
+        plugins={
+            "data": {'data_dir': 'tests/inexistent'}
+        },
+    )
+
+    build(mkdocs_config)
+
+    dataPlugin = mkdocs_config["plugins"]["data"]
+    data = dataPlugin.data
+
+    assert data == {}
+
+
+def test_loads_files():
+    mkdocs_config = load_config(
+        "tests/mkdocs.yml",
+        plugins={
+            "data": {'data_dir': 'tests/data'}
+        },
+    )
+
+    build(mkdocs_config)
+
+    dataPlugin = mkdocs_config["plugins"]["data"]
+    data = dataPlugin.data
+
+    assert data == {
+            "a": {
+                "a1": 1,
+                "a2": "text",
+            },
+            "dir1": {
+                "b": {
+                    "b1": 2,
+                    "b2": "text",
+                },
+            },
+            "dir2": {
+                "c": {
+                    "c1": 3,
+                    "c2": "text",
+                },
+            },
+    }