Refactor module and function naming

Author: lukasmasuch

setup.py

@@ -15,7 +15,7 @@
 AUTHOR = "ML Tooling Team"
 LICENSE = "MIT"
 REQUIRES_PYTHON = ">=3.6"
-VERSION = None  # Only set version if you like to overwrite the version in about.py
+VERSION = None  # Only set version if you like to overwrite the version in _about.py
 
 # Please define the requirements within the requirements.txt
 
@@ -57,10 +57,10 @@ def load_requirements(path_dir=PWD, file_name="requirements.txt", comment_char="
 with open(os.path.join(PWD, "README.md"), encoding="utf-8") as f:
     long_description = f.read()
 
-# Load the package's about.py module as a dictionary.
+# Load the package's _about.py module as a dictionary.
 about = {}  # type: dict
 if not VERSION:
-    with open(os.path.join(PWD, os.path.join("src", MAIN_PACKAGE), "about.py")) as f:  # type: ignore
+    with open(os.path.join(PWD, os.path.join("src", MAIN_PACKAGE), "_about.py")) as f:  # type: ignore
         # todo: extract version via regex? re.findall("__version__ = '([\d.\w]+)'", f.read())[0]
         exec(f.read(), about)
         VERSION = about["__version__"]

src/lazydocs/__init__.py

@@ -3,4 +3,4 @@
 # define the version before the other imports since these need it
 __version__ = _about.__version__
 
-from . import generator
+from .generation import MarkdownGenerator, generate_docs

src/lazydocs/_cli.py

@@ -4,27 +4,27 @@
 
 import typer
 
-import lazydocs.generator
+import lazydocs.generation
 
 app = typer.Typer()
 
 
 @app.command()
 def generate(
     paths: List[str] = typer.Argument(
-        ..., help="Selected paths or import name for markdown generation."
+        ..., help="Selected paths or imports for markdown generation."
     ),
     output_path: str = typer.Option(
         "./docs/",
         help="The output path for the creation of the markdown files. Set this to `stdout` to print all markdown to stdout.",
     ),
-    github_link: Optional[str] = typer.Option(
+    src_base_url: Optional[str] = typer.Option(
         None,
-        help="The base github link. Should include branch name. All source links are generated with this prefix.",
+        help="The base repo link used as prefix for all source links. Should also include the branch name.",
     ),
     overview_file: Optional[str] = typer.Option(
         None,
-        help="Filename of overview file. If not provided, no overview file will be generated.",
+        help="Filename of overview file. If not provided, no API overview file will be generated.",
     ),
     remove_package_prefix: bool = typer.Option(
         True,
@@ -43,12 +43,12 @@ def generate(
         help="If `True`, validate the docstrings via pydocstyle. Requires pydocstyle to be installed.",
     ),
 ) -> None:
-    """Generates markdown documentation for provided path based on Google-style docstrings."""
+    """Generates markdown documentation for your Python project based on Google-style docstrings."""
 
     lazydocs.generator.generate_docs(
         paths=paths,
         output_path=output_path,
-        src_base_url=github_link,
+        src_base_url=src_base_url,
         remove_package_prefix=remove_package_prefix,
         ignored_modules=ignored_modules,
         overview_file=overview_file,

src/lazydocs/generator.py renamed to src/lazydocs/generation.py

@@ -186,7 +186,7 @@ def to_md_file(
 
     if watermark:
         string += _WATERMARK_TEMPLATE.format(
-            date=datetime.date.today().strftime("%d, %b %Y")
+            date=datetime.date.today().strftime("%d %b %Y")
         )
 
     with open(os.path.join(out_path, md_file), "w") as f:
@@ -244,7 +244,7 @@ def _get_src_root_path(obj: Any) -> str:
     return module.__file__.split(root_package)[0] + root_package
 
 
-class MarkdownAPIGenerator(object):
+class MarkdownGenerator(object):
     """Markdown generator class."""
 
     def __init__(
@@ -800,8 +800,8 @@ def generate_docs(
             # Ignore all exceptions
             pass
 
-    # Initilize Markdown Generator
-    generator = MarkdownAPIGenerator(
+    # Initialize Markdown Generator
+    generator = MarkdownGenerator(
         src_root_path=src_root_path,
         src_base_url=src_base_url,
         remove_package_prefix=remove_package_prefix,