nbsync 0.1.4__py3-none-any.whl → 0.2.0__py3-none-any.whl

nbsync/cell.py

@@ -5,10 +5,9 @@ import uuid
 from dataclasses import dataclass
 from typing import TYPE_CHECKING
 
+from nbsync import logger
 from nbsync.markdown import is_truelike
 
-from .logger import logger
-
 if TYPE_CHECKING:
     from nbstore.markdown import Image
 

nbsync/logger.py

@@ -1,5 +1,32 @@
 from __future__ import annotations
 
-from mkdocs.plugins import get_plugin_logger
+import logging
+from logging import Logger
+from typing import Any
 
-logger = get_plugin_logger("nbsync")
+_logger = logging.getLogger("nbsync")
+
+
+def configure(logger: Logger | None = None) -> Logger:
+    global _logger  # noqa: PLW0603
+
+    if logger:
+        _logger = logger
+
+    return _logger
+
+
+def debug(msg: str, *args: Any, **kwargs: Any) -> None:
+    _logger.debug(msg, *args, **kwargs)
+
+
+def info(msg: str, *args: Any, **kwargs: Any) -> None:
+    _logger.info(msg, *args, **kwargs)
+
+
+def warning(msg: str, *args: Any, **kwargs: Any) -> None:
+    _logger.warning(msg, *args, **kwargs)
+
+
+def error(msg: str, *args: Any, **kwargs: Any) -> None:
+    _logger.error(msg, *args, **kwargs)

nbsync/sync.py

@@ -10,12 +10,11 @@ from nbstore.markdown import CodeBlock, Image
 from nbstore.notebook import get_language, get_mime_content, get_source
 
 import nbsync.markdown
+from nbsync import logger
 from nbsync.cell import Cell
 from nbsync.markdown import is_truelike
 from nbsync.notebook import Notebook
 
-from .logger import logger
-
 if TYPE_CHECKING:
     from collections.abc import Iterator
 

{nbsync-0.1.4.dist-info → nbsync-0.2.0.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: nbsync
-Version: 0.1.4
-Summary: MkDocs plugin treating Jupyter notebooks, Python scripts and Markdown files as first-class citizens for documentation with dynamic execution and real-time synchronization
+Version: 0.2.0
+Summary: A core library to synchronize Jupyter notebooks and Markdown documents, enabling seamless integration and dynamic content execution
 Project-URL: Documentation, https://daizutabi.github.io/nbsync/
 Project-URL: Source, https://github.com/daizutabi/nbsync
 Project-URL: Issues, https://github.com/daizutabi/nbsync/issues
@@ -28,7 +28,7 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
 License-File: LICENSE
-Keywords: documentation,dynamic-execution,jupyter,markdown,mkdocs,notebook,python,real-time-sync,visualization
+Keywords: documentation,dynamic-execution,jupyter,markdown,notebook,python,real-time-sync,visualization
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.10
@@ -39,8 +39,7 @@ Classifier: Topic :: Documentation
 Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Text Processing :: Markup :: Markdown
 Requires-Python: >=3.10
-Requires-Dist: mkdocs>=1.6
-Requires-Dist: nbstore>=0.4.7
+Requires-Dist: nbstore>=0.4.11
 Description-Content-Type: text/markdown
 
 # nbsync
@@ -50,11 +49,9 @@ Description-Content-Type: text/markdown
 [![Build Status][GHAction-image]][GHAction-link]
 [![Coverage Status][codecov-image]][codecov-link]
 
-<strong>Connect Jupyter notebooks to your MkDocs documentation</strong>
+<strong>Connect Jupyter notebooks and Markdown documents</strong>
 
-nbsync is a MkDocs plugin that seamlessly embeds Jupyter notebook
-visualizations in your documentation, solving the disconnect between
-code development and documentation.
+nbsync is a core library that seamlessly bridges Jupyter notebooks and Markdown documents, enabling dynamic content synchronization and execution.
 
 ## Why Use nbsync?
 
@@ -68,7 +65,7 @@ Data scientists, researchers, and technical writers face a common dilemma:
 
 ### Our Solution
 
-This plugin creates a live bridge between your notebooks and documentation by:
+nbsync creates a live bridge between your notebooks and markdown documents by:
 
 - **Keeping environments separate** - work in the tool best suited for each task
 - **Maintaining connections** - reference specific figures from notebooks
@@ -86,7 +83,7 @@ This plugin creates a live bridge between your notebooks and documentation by:
 
 - **Automatic Updates**:
   When you modify your notebooks, your documentation updates
-  automatically in MkDocs serve mode.
+  automatically.
 
 - **Clean Source Documents**:
   Your markdown remains readable and focused on content, without
@@ -104,14 +101,27 @@ This plugin creates a live bridge between your notebooks and documentation by:
 pip install nbsync
 ```
 
-### 2. Configuration
+### 2. Basic Usage
 
-Add to your `mkdocs.yml`:
+```python
+from nbsync.sync import Synchronizer
+from nbstore import Store
+
+# Initialize with a notebook store
+store = Store("path/to/notebooks")
+sync = Synchronizer(store)
+
+# Process markdown with notebook references
+markdown_text = """
+# My Document
+
+![Chart description](my-notebook.ipynb){#my-figure}
+"""
 
-```yaml
-plugins:
-  - nbsync:
-      src_dir: ../notebooks
+# Convert markdown with notebook references to final output
+for element in sync.convert(markdown_text):
+    # Process each element (string or Cell objects)
+    print(element)
 ```
 
 ### 3. Mark Figures in Your Notebook
@@ -140,14 +150,14 @@ Creating documentation and developing visualizations involve different
 workflows and timeframes. When building visualizations in Jupyter notebooks,
 you need rapid cycles of execution, verification, and modification.
 
-This plugin is designed specifically to address these separation of
+nbsync is designed specifically to address these separation of
 concerns, allowing you to:
 
 - **Focus on code** in notebooks without documentation distractions
 - **Focus on narrative** in markdown without code interruptions
 - **Maintain powerful connections** between both environments
 
-Each environment is optimized for its purpose, while the plugin
+Each environment is optimized for its purpose, while nbsync
 handles the integration automatically.
 
 ## Contributing

nbsync-0.2.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+nbsync/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nbsync/cell.py,sha256=C7VqQO3mxZ7Nj4ufywTnaqZAegT7zqA6iN2WV6X5X5c,3786
+nbsync/logger.py,sha256=XzkJVBD1SATP5Nhh9tuUL_tS4Mc5MDeVtp8yYiRePxs,688
+nbsync/markdown.py,sha256=xcPhQKWpFDyVQ_xtZCpFrnR0QED_hYs4PAyaT7dF3t4,3830
+nbsync/notebook.py,sha256=Voh-e8RQsoYmWKnaHzAn4bm6Ud5v-aHwmng2Uc0rUts,1009
+nbsync/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nbsync/sync.py,sha256=3gLLAACjKGiFCODCgxw5lqr0m3_Naxjv-oWizP3J4QY,3833
+nbsync-0.2.0.dist-info/METADATA,sha256=ofKBu3lFz1Nz6PW-2SKB0lrLWHARjfVprdCAqfM6BR4,6552
+nbsync-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+nbsync-0.2.0.dist-info/licenses/LICENSE,sha256=wy1pqn52upuo_qYwY-epWmspwE-3UWJso0xodciGXYc,1062
+nbsync-0.2.0.dist-info/RECORD,,

nbsync/plugin.py

@@ -1,96 +0,0 @@
-from __future__ import annotations
-
-from pathlib import Path
-from typing import TYPE_CHECKING, ClassVar
-
-from mkdocs.config import Config as BaseConfig
-from mkdocs.config import config_options
-from mkdocs.plugins import BasePlugin
-from mkdocs.structure.files import File
-from nbstore.store import Store
-
-from .logger import logger
-from .sync import Synchronizer
-
-if TYPE_CHECKING:
-    from typing import Any
-
-    from mkdocs.config.defaults import MkDocsConfig
-    from mkdocs.structure.files import Files
-    from mkdocs.structure.pages import Page
-
-    from .cell import Cell
-
-
-class Config(BaseConfig):
-    """Configuration for Nbstore plugin."""
-
-    src_dir = config_options.Type((str, list), default=".")
-
-
-class Plugin(BasePlugin[Config]):
-    store: ClassVar[Store | None] = None
-    syncs: ClassVar[dict[str, Synchronizer]] = {}
-    files: Files
-
-    def on_config(self, config: MkDocsConfig, **kwargs: Any) -> MkDocsConfig:
-        if isinstance(self.config.src_dir, str):
-            src_dirs = [self.config.src_dir]
-        else:
-            src_dirs = self.config.src_dir
-
-        src_dirs = [(Path(config.docs_dir) / s).resolve() for s in src_dirs]
-
-        store = self.__class__.store
-
-        if store is None or store.src_dirs != src_dirs:
-            self.__class__.store = Store(src_dirs)
-            config.watch.extend(x.as_posix() for x in src_dirs)
-
-        for name in ["attr_list", "md_in_html"]:
-            if name not in config.markdown_extensions:
-                config.markdown_extensions.append(name)
-
-        return config
-
-    def on_files(self, files: Files, config: MkDocsConfig, **kwargs: Any) -> Files:
-        self.files = files
-        return files
-
-    def on_page_markdown(
-        self,
-        markdown: str,
-        page: Page,
-        config: MkDocsConfig,
-        **kwargs: Any,
-    ) -> str:
-        if self.__class__.store is None:
-            msg = "Store must be initialized before processing markdown"
-            logger.error(msg)
-            return markdown
-
-        src_uri = page.file.src_uri
-        syncs = self.__class__.syncs
-
-        if src_uri not in syncs:
-            syncs[src_uri] = Synchronizer(self.__class__.store)
-
-        markdowns = []
-
-        for elem in syncs[src_uri].convert(markdown):
-            if isinstance(elem, str):
-                markdowns.append(elem)
-
-            elif markdown := elem.convert():
-                markdowns.append(markdown)
-
-                if elem.image.url and elem.content:
-                    file = generate_file(elem, src_uri, config)
-                    self.files.append(file)
-
-        return "".join(markdowns)
-
-
-def generate_file(cell: Cell, page_uri: str, config: MkDocsConfig) -> File:
-    src_uri = (Path(page_uri).parent / cell.image.url).as_posix()
-    return File.generated(config, src_uri, content=cell.content)

nbsync-0.1.4.dist-info/RECORD

@@ -1,13 +0,0 @@
-nbsync/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nbsync/cell.py,sha256=HNgMDwA1KrMxyoxAL2wUrg3zdA1glveoXY5YbO_uFeM,3788
-nbsync/logger.py,sha256=tQK8Z8HdWQNhVohQYLwZtJhdaj2w0UTyhHQak3mPqNc,119
-nbsync/markdown.py,sha256=xcPhQKWpFDyVQ_xtZCpFrnR0QED_hYs4PAyaT7dF3t4,3830
-nbsync/notebook.py,sha256=Voh-e8RQsoYmWKnaHzAn4bm6Ud5v-aHwmng2Uc0rUts,1009
-nbsync/plugin.py,sha256=YywBAD7fcrPg3-_9T_kSuvD8RBzsc_ovlIviGlKR9po,2835
-nbsync/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nbsync/sync.py,sha256=M21moADW2dgvQB46ahbcd2aXOHHqwx9CwfjNO7GR2mQ,3835
-nbsync-0.1.4.dist-info/METADATA,sha256=EzIqH3hnebqKZ0N1pFzGuE0zL-LNzyVYUyDKBNaRmRQ,6287
-nbsync-0.1.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-nbsync-0.1.4.dist-info/entry_points.txt,sha256=bSqmJTDmrUoSm4yDjk8YDWxI71SShx16judadGdiKbA,47
-nbsync-0.1.4.dist-info/licenses/LICENSE,sha256=wy1pqn52upuo_qYwY-epWmspwE-3UWJso0xodciGXYc,1062
-nbsync-0.1.4.dist-info/RECORD,,

nbsync-0.1.4.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[mkdocs.plugins]
-nbsync = nbsync.plugin:Plugin