mkdocs-data-plugin 0.2.0__tar.gz → 0.3.0__tar.gz

{mkdocs_data_plugin-0.2.0 → mkdocs_data_plugin-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: mkdocs-data-plugin
-Version: 0.2.0
+Version: 0.3.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
@@ -8,11 +8,13 @@ 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
+License-Expression: MIT
+License-File: LICENSE
 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
+Requires-Dist: mkdocs<2.0,>=1.5.2
+Requires-Dist: properdocs>=1.6
 Description-Content-Type: text/markdown
 
 # mkdocs-data-plugin

mkdocs_data_plugin-0.3.0/mkdocs_data_plugin/__init__.py

@@ -0,0 +1,5 @@
+import properdocs.replacement_warning
+
+properdocs.replacement_warning.setup()
+
+version = "0.3.0"

{mkdocs_data_plugin-0.2.0 → mkdocs_data_plugin-0.3.0}/pyproject.toml

@@ -16,7 +16,8 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 dependencies = [
-    "mkdocs>=1.5.2",
+    "mkdocs>=1.5.2,<2.0",
+    "properdocs>=1.6",
     "mkdocs-macros-plugin>=1.2.0",
 ]
 
@@ -63,17 +64,17 @@ type = ["default"]
 
 [tool.hatch.envs.doc]
 dependencies = [
-    "mkdocs-material[imaging]~=9.5",
+    "mkdocs-materialx[imaging]~=10.1",
     "mkdocs-alias-plugin~=0.8",
     "mkdocs-git-revision-date-localized-plugin~=1.2",
 ]
 
 [tool.hatch.envs.doc.scripts]
 serve = [
-    "mkdocs serve",
+    "properdocs serve",
 ]
 build = [
-    "mkdocs build",
+    "properdocs build",
 ]
 
 [tool.hatch.envs.style]

mkdocs_data_plugin-0.3.0/tests/data/a.yml

@@ -0,0 +1,2 @@
+number: 1
+string: text

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

@@ -0,0 +1,2 @@
+number: 2
+string: text

mkdocs_data_plugin-0.3.0/tests/data/dir1.yml

@@ -0,0 +1,2 @@
+number: 1
+string: text

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

@@ -0,0 +1,4 @@
+{
+  "number": 3,
+  "string": "text"
+}

mkdocs_data_plugin-0.3.0/tests/docs/test_dir_source.md

@@ -0,0 +1,11 @@
+---
+title: "Test Directory Source"
+---
+
+- data.a: `{{ data.a }}`
+- data.a.number: `{{ data.a.number }}`
+- data.a.string: `{{ data.a.string }}`
+- data.dir1.b.number: `{{ data.dir1.b.number }}`
+- data.dir1.b.string: `{{ data.dir1.b.string }}`
+- data.dir2.c.number: `{{ data.dir2.c.number }}`
+- data.dir2.c.string: `{{ data.dir2.c.string }}`

{mkdocs_data_plugin-0.2.0 → mkdocs_data_plugin-0.3.0}/tests/test_data_template.py

@@ -20,13 +20,13 @@ def test_dir_source_in_markdown_file():
         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
+            "{'number': 1, 'string': 'text'}", # data/a.yml
+            "1", # data/a.yml -> number
+            "text", # data/a.yml -> string
+            "2", # data/dir1/b.yml -> number
+            "text", # data/dir1/b.yml -> string
+            "3", # data/dir2/c.yml -> number
+            "text", # data/dir2/c.yml -> string
         ])
 
 def test_file_source_in_markdown_file():

{mkdocs_data_plugin-0.2.0 → mkdocs_data_plugin-0.3.0}/tests/test_load_data.py

@@ -32,19 +32,21 @@ def test_folder_source():
 
     assert data == {
             "a": {
-                "a1": 1,
-                "a2": "text",
+                "number": 1,
+                "string": "text",
             },
             "dir1": {
+                "number": 1,
+                "string": "text",
                 "b": {
-                    "b1": 2,
-                    "b2": "text",
+                    "number": 2,
+                    "string": "text",
                 },
             },
             "dir2": {
                 "c": {
-                    "c1": 3,
-                    "c2": "text",
+                    "number": 3,
+                    "string": "text",
                 },
             },
     }
@@ -64,19 +66,21 @@ def test_folder_source_slash():
 
     assert data == {
             "a": {
-                "a1": 1,
-                "a2": "text",
+                "number": 1,
+                "string": "text",
             },
             "dir1": {
+                "number": 1,
+                "string": "text",
                 "b": {
-                    "b1": 2,
-                    "b2": "text",
+                    "number": 2,
+                    "string": "text",
                 },
             },
             "dir2": {
                 "c": {
-                    "c1": 3,
-                    "c2": "text",
+                    "number": 3,
+                    "string": "text",
                 },
             },
     }

mkdocs_data_plugin-0.2.0/mkdocs_data_plugin/__init__.py

@@ -1 +0,0 @@
-version = "0.2.0"

mkdocs_data_plugin-0.2.0/tests/data/a.yml

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

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

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

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

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

mkdocs_data_plugin-0.2.0/tests/docs/test_dir_source.md

@@ -1,11 +0,0 @@
----
-title: "Test Directory Source"
----
-
-- 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 }}`