mkdocs-placeholder-plugin 0.5.2.dev1__tar.gz → 0.5.2.dev3__tar.gz

{mkdocs_placeholder_plugin-0.5.2.dev1 → mkdocs_placeholder_plugin-0.5.2.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mkdocs-placeholder-plugin
-Version: 0.5.2.dev1
+Version: 0.5.2.dev3
 Summary: Add dynamic placeholders to your mkdocs page
 License: MIT
 Author: six-two
@@ -211,8 +211,12 @@ This is just for me :)
 3. Update version number in `./pyproject.toml` and `typescript/src/api.ts`.
 4. Run `./build.sh` to compile the latest JavaScript code and test that it works. **`poetry build` will only build the latest Python code,** and incompatibilities between Python and JS code can break the release.
 4. Disable `debug_javascript` in `placeholder-plugin.yaml`.
-5. Build and update package.
-6. Create a commit for the release (`Version 0.X.Y`) and push it.
+5. Build and update package:
+    ```bash
+    poetry build
+    poetry publish
+    ```
+6. Create a commit for the release (`release: Version 0.X.Y`) and push it.
 7. Add a tag named `0.X.Y`:
     ```bash
     git tag 0.X.Y
@@ -224,7 +228,7 @@ This is just for me :)
     git push --tags origin latest-release
     ```
 
-### Updating python dependencies
+### @TODO: Update - Updating python dependencies
 
 If you don't have them, install `pip-tools`:
 ```bash

{mkdocs_placeholder_plugin-0.5.2.dev1 → mkdocs_placeholder_plugin-0.5.2.dev3}/README.md

@@ -193,8 +193,12 @@ This is just for me :)
 3. Update version number in `./pyproject.toml` and `typescript/src/api.ts`.
 4. Run `./build.sh` to compile the latest JavaScript code and test that it works. **`poetry build` will only build the latest Python code,** and incompatibilities between Python and JS code can break the release.
 4. Disable `debug_javascript` in `placeholder-plugin.yaml`.
-5. Build and update package.
-6. Create a commit for the release (`Version 0.X.Y`) and push it.
+5. Build and update package:
+    ```bash
+    poetry build
+    poetry publish
+    ```
+6. Create a commit for the release (`release: Version 0.X.Y`) and push it.
 7. Add a tag named `0.X.Y`:
     ```bash
     git tag 0.X.Y
@@ -206,7 +210,7 @@ This is just for me :)
     git push --tags origin latest-release
     ```
 
-### Updating python dependencies
+### @TODO: Update - Updating python dependencies
 
 If you don't have them, install `pip-tools`:
 ```bash

{mkdocs_placeholder_plugin-0.5.2.dev1 → mkdocs_placeholder_plugin-0.5.2.dev3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs-placeholder-plugin"
-version = "0.5.2.dev1"
+version = "0.5.2.dev3"
 description = "Add dynamic placeholders to your mkdocs page"
 authors = [
     {name = "six-two",email = "pip@six-two.dev"}
@@ -20,7 +20,13 @@ requires = ["poetry-core>=2.0.0,<3.0.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-include = ["src/mkdocs_placeholder_plugin/assets/*", "LICENSE", "README.md"]
+include = [
+    { path = "src/mkdocs_placeholder_plugin/assets/placeholder-data.js", format = ["sdist", "wheel"] },
+    { path = "src/mkdocs_placeholder_plugin/assets/placeholder.min.js", format = ["sdist", "wheel"] },
+    { path = "src/mkdocs_placeholder_plugin/assets/placeholder.min.js.map", format = ["sdist", "wheel"] },
+    "LICENSE",
+    "README.md"
+]
 
 [tool.poetry.group.dev.dependencies]
 mkdocs-material = "^9.6.18"

{mkdocs_placeholder_plugin-0.5.2.dev1 → mkdocs_placeholder_plugin-0.5.2.dev3}/src/mkdocs_placeholder_plugin/assets/__init__.py

@@ -2,6 +2,7 @@ import os
 import shutil
 from typing import Optional
 # local
+from ..generic import LOGGER
 from ..generic.config import PlaceholderConfig
 from ..generic.json_generator import generate_json_for_javascript_code
 
@@ -60,8 +61,11 @@ def copy_assets_to_directory_debuggable(generic_config: PlaceholderConfig, outpu
 
 def read_resource_file(name: str) -> str:
     path = get_resource_path(name)
-    with open(path, "r") as f:
-        return f.read()
+    try:
+        with open(path, "r") as f:
+            return f.read()
+    except Exception as ex:
+        LOGGER.error(f"Failed to read resource '{name}' (full path: {path}) because of error: {ex}")