mkdocs-data-plugin 0.1.0__py3-none-any.whl

mkdocs_data_plugin/__init__.py

@@ -0,0 +1,2 @@
+version = "0.1.0"
+__version__ = "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.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,6 @@
+mkdocs_data_plugin/__init__.py,sha256=cN0zX9gYNljh3D9btS9CoJ9ot7pJI9L19IzFTtAtLd4,40
+mkdocs_data_plugin/plugin.py,sha256=X6h6QmGPUfjzy-dF_aAv1eK3E-DpoCU6hMBuPj9VGr4,2115
+mkdocs_data_plugin-0.1.0.dist-info/METADATA,sha256=X4ohyRjPLxp-T5WGDsZ2lfxx6Cvf40deI-JDUZOhs3U,1190
+mkdocs_data_plugin-0.1.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+mkdocs_data_plugin-0.1.0.dist-info/entry_points.txt,sha256=OPCZHj_0qGtoX7jiNvaejvGQYPK_b7CmhSbLKAsxzl4,61
+mkdocs_data_plugin-0.1.0.dist-info/RECORD,,

mkdocs_data_plugin-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.26.3
+Root-Is-Purelib: true
+Tag: py3-none-any

mkdocs_data_plugin-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[mkdocs.plugins]
+data = mkdocs_data_plugin.plugin:DataPlugin