Make cli and about to private modules

Author: lukasmasuch

build.py

@@ -20,7 +20,7 @@ def main(args: Dict[str, Union[bool, str]]):
     version = args[build_utils.FLAG_VERSION]
     if args[build_utils.FLAG_VERSION]:
         # Replace version in about.py
-        with open(os.path.join(HERE, f"src/{MAIN_PACKAGE}/about.py"), "r+") as f:
+        with open(os.path.join(HERE, f"src/{MAIN_PACKAGE}/_about.py"), "r+") as f:
             data = f.read()
             f.seek(0)
             f.write(re.sub(r"__version__ = \".+\"", f'__version__ = "{version}"', data))

setup.py

@@ -118,7 +118,7 @@ def load_requirements(path_dir=PWD, file_name="requirements.txt", comment_char="
         "Source": URL,
     },
     entry_points={
-        "console_scripts": [f"{NAME}={MAIN_PACKAGE}.cli:app"],
+        "console_scripts": [f"{NAME}={MAIN_PACKAGE}._cli:app"],
     },
     keywords=[
         # eg: 'keyword1', 'keyword2', 'keyword3',

src/lazydocs/__init__.py

@@ -1,6 +1,6 @@
-from . import about
+from . import _about
 
 # define the version before the other imports since these need it
-__version__ = about.__version__
+__version__ = _about.__version__
 
-# TODO do your imports here
+from . import generator

src/lazydocs/_about.py

@@ -0,0 +1,5 @@
+"""Information about this library. This file will automatically changed."""
+
+__version__ = "0.1.3"
+# __author__
+# __email__

src/lazydocs/cli.py renamed to src/lazydocs/_cli.py

@@ -1,3 +1,5 @@
+"""Command line interface of lazydocs."""
+
 from typing import List, Optional
 
 import typer
@@ -20,10 +22,22 @@ def generate(
         None,
         help="The base github link. Should include branch name. All source links are generated with this prefix.",
     ),
+    overview_file: Optional[str] = typer.Option(
+        None,
+        help="Filename of overview file. If not provided, no overview file will be generated.",
+    ),
     remove_package_prefix: bool = typer.Option(
         True,
         help="If `True`, the package prefix will be removed from all functions and methods.",
     ),
+    ignored_modules: List[str] = typer.Option(
+        [],
+        help="A list of modules that should be ignored.",
+    ),
+    watermark: bool = typer.Option(
+        True,
+        help="If `True`, add a watermark with a timestamp to bottom of the markdown files.",
+    ),
     validate: bool = typer.Option(
         False,
         help="If `True`, validate the docstrings via pydocstyle. Requires pydocstyle to be installed.",
@@ -36,6 +50,9 @@ def generate(
         output_path=output_path,
         src_base_url=github_link,
         remove_package_prefix=remove_package_prefix,
+        ignored_modules=ignored_modules,
+        overview_file=overview_file,
+        watermark=watermark,
         validate=validate,
     )