Merge pull request #26 from ayasyrev/dev_0.2

0.2

Author: ayasyrev

.gitignore

@@ -1,5 +1,6 @@
 .vscode/
 tmp*/
+tmp*
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

noxfile_conda.py

@@ -2,7 +2,7 @@
 
 
 @nox.session(python=["3.8", "3.9", "3.10", "3.11"], venv_backend="mamba")
-def tests(session: nox.Session) -> None:
+def conda_tests(session: nox.Session) -> None:
     args = session.posargs or ["--cov"]
     session.install("pytest", "pytest-cov")
     session.install("-e", ".")

noxfile_conda_lint.py

@@ -4,7 +4,7 @@
 
 
 @nox.session(python=["3.8", "3.9", "3.10", "3.11"], venv_backend="mamba")
-def lint(session: nox.Session) -> None:
+def conda_lint(session: nox.Session) -> None:
     args = session.posargs or locations
     session.conda_install("flake8")
     session.run("flake8", *args)

noxfile_cov.py

@@ -2,7 +2,7 @@
 
 
 @nox.session(python=["3.10"])
-def tests(session: nox.Session) -> None:
+def cov_tests(session: nox.Session) -> None:
     args = session.posargs or ["--cov"]
     session.install(".", "pytest", "pytest-cov", "coverage[toml]")
     session.run("pytest", *args)

requirements.txt

@@ -1,5 +1,4 @@
 nbformat
 nbconvert
-typer
 rich
-pydantic
+argparsecfg

setup.cfg

@@ -24,10 +24,10 @@ where = src
 
 [options.entry_points]
 console_scripts =
-    nbdocs=nbdocs.apps.app_nbdocs:app
-    nb2md=nbdocs.apps.app_nb2md:app
-    nbclean=nbdocs.apps.app_nbclean:app
+    nbdocs=nbdocs.apps.app_nbdocs:main
+    nb2md=nbdocs.apps.app_nb2md:main
+    nbclean=nbdocs.apps.app_nbclean:main
 pipx.run =
-    nbdocs=nbdocs.apps.app_nbdocs:app
-    nb2md=nbdocs.apps.app_nb2md:app
-    nbclean=nbdocs.apps.app_nbclean:app
+    nbdocs=nbdocs.apps.app_nbdocs:main
+    nb2md=nbdocs.apps.app_nb2md:main
+    nbclean=nbdocs.apps.app_nbclean:main

src/nbdocs/__main__.py

@@ -1,3 +1,3 @@
-from nbdocs.apps.app_nbdocs import app
+from nbdocs.apps.app_nbdocs import main
 
-app()
+main()

src/nbdocs/apps/app_nb2md.py

@@ -1,56 +1,96 @@
+from dataclasses import dataclass
 from pathlib import Path
-import typer
+import sys
+from typing import Optional, Sequence
+
+from argparsecfg import ArgumentParserCfg, field_argument, parse_args
+from rich import print as rprint
+
 from nbdocs.convert import convert2md, filter_changed
 from nbdocs.core import get_nb_names
 from nbdocs.settings import get_config
 
-app = typer.Typer(rich_markup_mode="rich")
+
+parser_cfg = ArgumentParserCfg(description="Nb2Md. Convert notebooks to Markdown.")
+
+
+@dataclass
+class AppConfig:
+    nb_path: str = field_argument(
+        "nb_path",
+        help="Path to NB or folder with Nbs to convert",
+    )
+    dest_path: str = field_argument(
+        default=None,
+        flag="--dest",
+        help="Docs path.",
+    )
+    images_path: str = field_argument(
+        default=None,
+        help="Image path at docs.",
+    )
+    force: bool = field_argument(
+        "-F",
+        default=False,
+        action="store_true",
+        help="Force convert all notebooks.",
+    )
+    silent_mode: bool = field_argument(
+        "-s",
+        default=False,
+        action="store_true",
+        help="Run in silent mode.",
+    )
 
 
-@app.command()
 def convert(
-    nb_path: str = typer.Argument(..., help="Path to NB or folder with Nbs to convert"),
-    dest_path: str = typer.Option(None, "--dest", "--dest-path", help="Docs path."),
-    images_path: str = typer.Option(None, help="Image path at docs."),
-    force: bool = typer.Option(
-        False, "-F", "--force", help="Force convert all notebooks."
-    ),
-    silent_mode: bool = typer.Option(False, "-s", help="Run in silent mode."),
+    app_cfg: AppConfig,
 ) -> None:
     """Nb2Md. Convert notebooks to Markdown."""
-    nb_names = get_nb_names(nb_path)
-    if len(nb_names) == 0:
-        typer.echo("No files to convert!")
-        raise typer.Exit()
+    nb_names = get_nb_names(app_cfg.nb_path)
+    nbs_number = len(nb_names)
+    if nbs_number == 0:
+        rprint("No files to convert!")
+        sys.exit()
+    rprint(f"Found {nbs_number} notebooks.")
 
     cfg = get_config(
-        notebooks_path=nb_path, docs_path=dest_path, images_path=images_path
+        notebooks_path=app_cfg.nb_path, docs_path=app_cfg.dest_path, images_path=app_cfg.images_path
     )
 
     # check logic -> do we need subdir and how to check modified Nbs
     # if convert whole directory, put result to docs subdir.
-    if (path := Path(nb_path)).is_dir():
+    if (path := Path(app_cfg.nb_path)).is_dir():
         cfg.docs_path = f"{cfg.docs_path}/{path.name}"
     Path(cfg.docs_path).mkdir(parents=True, exist_ok=True)
     (Path(cfg.docs_path) / cfg.images_path).mkdir(exist_ok=True)
 
-    if not force:
+    if not app_cfg.force:
+        message = "Filtering notebooks with changes... "
         nb_names = filter_changed(nb_names, cfg)
+        if len(nb_names) == nbs_number:
+            message += "No changes."
+        rprint(message)
 
     if len(nb_names) == 0:
-        typer.echo("No files with changes to convert!")
-        raise typer.Exit()
+        rprint("No files with changes to convert!")
+        sys.exit()
 
-    if not silent_mode:
+    if not app_cfg.silent_mode:
         print(f"Files to convert from {nb_names[0].parent}:")
         for fn in nb_names:
             print(f"    {fn.name}")
         print(
-            f"Destination directory: {dest_path},\nImage directory: {cfg.images_path}"
+            f"Destination directory: {app_cfg.dest_path},\nImage directory: {cfg.images_path}"
         )
 
     convert2md(nb_names, cfg)
 
 
+def main(args: Optional[Sequence[str]] = None) -> None:
+    app_cfg = parse_args(AppConfig, parser_cfg, args)
+    convert(app_cfg)
+
+
 if __name__ == "__main__":  # pragma: no cover
-    app()
+    main()

src/nbdocs/apps/app_nbclean.py

@@ -1,31 +1,51 @@
-import typer
+import sys
+from dataclasses import dataclass
+from typing import Optional, Sequence
+
+from argparsecfg import field_argument, parse_args, ArgumentParserCfg
+from rich import print as rprint
+
 from nbdocs.clean import clean_nb_file
 from nbdocs.core import get_nb_names
 from nbdocs.settings import get_config
 
-app = typer.Typer(rich_markup_mode="rich")
 
+parser_cfg = ArgumentParserCfg(
+    description="Clean Nb or notebooks at `nb_path` - metadata and execution counts from nbs."
+)
+
+
+@dataclass
+class AppConfig:
+    """Config for `app_nbclean`."""
 
-@app.command()
-def nbclean(
-    nb_path: str = typer.Argument(None, help="Path to NB or folder with Nbs to clean"),
-    clear_execution_count: bool = typer.Option(
-        True, "--ec", help="Clean execution counts."
-    ),
-) -> None:
+    nb_path: str = field_argument(
+        "nb_path", help="Path to NB or folder with Nbs to clean"
+    )
+    clear_execution_count: bool = field_argument(
+        flag="--no-ec", default=True, action="store_false", help="Clean execution counts."
+    )
+
+
+def nbclean(app_cfg: AppConfig) -> None:
     """Clean Nb or notebooks at `nb_path` - metadata and execution counts from nbs."""
-    cfg = get_config(notebooks_path=nb_path)
+    cfg = get_config(notebooks_path=app_cfg.nb_path)
 
     nb_names = get_nb_names(cfg.notebooks_path)
 
     if (num_nbs := len(nb_names)) == 0:
-        typer.echo("No files to clean!")
-        raise typer.Abort()
+        rprint("No files to clean!")
+        sys.exit()
+
+    rprint(f"Clean: {cfg.notebooks_path}, found {num_nbs} notebooks.")
+
+    clean_nb_file(nb_names, app_cfg.clear_execution_count)
 
-    typer.echo(f"Clean: {cfg.notebooks_path}, found {num_nbs} notebooks.")
 
-    clean_nb_file(nb_names, clear_execution_count)
+def main(args: Optional[Sequence[str]] = None) -> None:
+    app_cfg = parse_args(AppConfig, parser_cfg, args)
+    nbclean(app_cfg)
 
 
 if __name__ == "__main__":  # pragma: no cover
-    app()
+    main()

src/nbdocs/apps/app_nbdocs.py

@@ -1,30 +1,54 @@
-import typer
+import sys
+from dataclasses import dataclass
+from typing import Optional, Sequence
+
+from argparsecfg import ArgumentParserCfg, field_argument, parse_args
+from rich import print as rprint
 
 from nbdocs.convert import convert2md, filter_changed
 from nbdocs.core import get_nb_names
 from nbdocs.settings import get_config
 
-app = typer.Typer(rich_markup_mode="rich")
+parser_cfg = ArgumentParserCfg(description="NbDocs. Convert notebooks to docs. Default to .md")
+
+
+@dataclass
+class AppConfig:
+    force: bool = field_argument(
+        "-F",
+        default=False,
+        help="Force convert all notebooks.",
+    )
 
 
-@app.command()
-def nbdocs(
-    force: bool = typer.Option(
-        False, "-F", "--force", help="Force convert all notebooks."
-    ),
-) -> None:
+def nbdocs(app_cfg: AppConfig,) -> None:
     """NbDocs. Convert notebooks to docs. Default to .md"""
     cfg = get_config()
     nb_names = get_nb_names(cfg.notebooks_path)
-    if not force:
+    nbs_number = len(nb_names)
+    if nbs_number == 0:
+        rprint("No files to convert!")
+        sys.exit()
+    rprint(f"Found {nbs_number} notebooks.")
+    if not app_cfg.force:
+        message = "Filtering notebooks with changes... "
         nb_names = filter_changed(nb_names, cfg)
+        if len(nb_names) == nbs_number:
+            message += "No changes."
+        rprint(message)
 
     if len(nb_names) == 0:
-        typer.echo("No files to convert!")
-        raise typer.Exit()
+        rprint("No files to convert!")
+        sys.exit()
 
+    rprint(f"To convert: {len(nb_names)} notebooks.")
     convert2md(nb_names, cfg)
 
 
+def main(args: Optional[Sequence[str]] = None) -> None:
+    app_cfg = parse_args(AppConfig, parser_cfg, args)
+    nbdocs(app_cfg)
+
+
 if __name__ == "__main__":
-    app()
+    main()