add docs and batch add readmes tool

Author: cnheider

.github/images/devpack.png

@@ -102,6 +102,7 @@ ENV/
 
 # Spyder project settings
 .spyderproject
+*.out
 .spyproject
 
 # mkdocs documentation
@@ -125,5 +126,4 @@ logs/*.csv
 
 
 pip-wheel-metadata
-.pytest_cache
 build/

.gitignore

@@ -1,7 +1,7 @@
 fail_fast: true
 repos:
   - repo: https://github.com/ambv/black
-    rev: 22.1.0
+    rev: 22.6.0
     hooks:
       - id: black
         language_version: python3.8

.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+    # You can also specify other tool versions:
+    # nodejs: "16"
+    # rust: "1.55"
+    # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - requirements: requirements/requirements_dev.txt

.readthedocs.yaml

@@ -1,5 +1,11 @@
-# ProjectName
+# DevPack
 
 ```bash
-pip install projectname
-```
+pip install devpack -U
+```
+
+Get a decent development
+
+Contains some useful batching tools for python package development
+
+- Auto add readmes to packages, with breadcrumbs

README.md

@@ -10,7 +10,7 @@
 
 __project__ = "devpack"
 __author__ = "Christian Heider Nielsen"
-__version__ = "0.0.4"
+__version__ = "0.0.5"
 __doc__ = """
 Created on 15/04/2020
 
@@ -22,7 +22,7 @@
 
 def dist_is_editable(dist: Any) -> bool:
     """
-    Return True if given Distribution is an editable install."""
+    Return True if given Distribution is an editable installation."""
     import sys
     from pathlib import Path
 
@@ -34,6 +34,8 @@ def dist_is_editable(dist: Any) -> bool:
 
 
 PROJECT_NAME = __project__.lower().strip().replace(" ", "_")
+PROJECT_VERSION = __version__
+PROJECT_YEAR = 2018
 PROJECT_AUTHOR = __author__.lower().strip().replace(" ", "_")
 PROJECT_APP_PATH = AppPath(app_name=PROJECT_NAME, app_author=PROJECT_AUTHOR)
 

benchmarks/__init__.py

@@ -0,0 +1,118 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+__author__ = "heider"
+__doc__ = r"""
+
+           Created on 8/18/22
+           """
+
+__all__ = ["auto_add_readme", "recursive_add_readmes", "TouchModeEnum"]
+
+from enum import Enum
+from pathlib import Path
+from typing import Callable, Iterable, Optional
+
+from sorcery import assigned_names
+
+
+class TouchModeEnum(Enum):
+    """
+    The touch mode enum
+
+    """
+
+    breadcrumb, empty, parent_name = assigned_names()
+
+
+def auto_add_readme(
+    path: Path,
+    *,
+    touch_mode: TouchModeEnum = TouchModeEnum.breadcrumb,
+    readme_name: str = "README.md",
+    root_path: Optional[Path] = Path.cwd(),
+    prefix="# ",
+) -> None:
+    """
+    Add a readme to the root_path if it does not exist
+
+    :param path:
+    :param touch_mode:
+    :param readme_name:
+    :param root_path:
+    :param prefix:
+    :return:
+
+    """
+    path = Path(path)
+    readme_file = path / readme_name
+    if not readme_file.exists():
+        readme_file.touch()
+        if touch_mode == TouchModeEnum.breadcrumb:
+            assert root_path is not None
+            readme_file.write_text(prefix + str(path.relative_to(root_path)))
+        elif touch_mode == TouchModeEnum.empty:
+            readme_file.write_text("")
+        elif touch_mode == TouchModeEnum.parent_name:
+            readme_file.write_text(prefix + str(readme_file.parent.name))
+        else:
+            raise ValueError(f"Unknown touch mode {touch_mode}")
+
+
+def is_python_module(path: Path) -> bool:
+    """
+    Check if path is a python module
+    """
+    return path.is_file() and path.suffix == ".py"
+
+
+def is_python_package(path: Path) -> bool:
+    """
+    Check if path is a python package
+    """
+    return path.is_dir() and (path / "__init__.py").exists()
+
+
+def negate(f: Callable) -> Callable:
+    """
+    Negate a function
+    """
+    return lambda *args, **kwargs: not f(*args, **kwargs)
+
+
+def recursive_add_readmes(
+    path: Path,
+    exclusion_filter: Optional[Iterable[Callable]] = (negate(is_python_package),),
+    *,
+    touch_mode: TouchModeEnum = TouchModeEnum.breadcrumb,
+    readme_name: str = "README.md",
+    root_path: Optional[Path] = None,
+) -> None:
+    """
+    recursively add readmes to all children spanning from root_path
+
+    """
+    path = Path(path)
+    if root_path is None:
+        root_path = path.parent
+
+    auto_add_readme(
+        path, touch_mode=touch_mode, readme_name=readme_name, root_path=root_path
+    )
+
+    for child in path.iterdir():
+        if exclusion_filter is None or not any(flt(child) for flt in exclusion_filter):
+            if child.is_dir():
+                recursive_add_readmes(
+                    child,
+                    exclusion_filter,
+                    touch_mode=touch_mode,
+                    readme_name=readme_name,
+                    root_path=root_path,
+                )
+            elif child.is_file():
+                pass
+
+
+if __name__ == "__main__":
+    recursive_add_readmes("exclude")

devpack/__init__.py

@@ -11,7 +11,7 @@
 import sys
 from typing import Optional
 
-__all__ = ["pip_install_development_package"]
+__all__ = ["pip_install_development_package", "pip_uninstall_package"]
 
 
 def pip_install_development_package(
@@ -20,7 +20,8 @@ def pip_install_development_package(
     extra_index: Optional[str] = "https://pypi.org/simple/",
     upgrade: bool = True,
 ) -> None:
-    """ """
+    """
+    Install package in development mode."""
     arguments = [
         "install",
         "--index-url",
@@ -42,6 +43,14 @@ def pip_install_development_package(
     subprocess.check_call([sys.executable, "-m", "pip", *arguments])
 
 
+def pip_uninstall_package(package: str) -> None:
+    """
+    Same as pip uninstall package, but may be expanded to include other options, like apppath clean up.
+    #TODO: APPPATH CLEANUP
+    """
+    subprocess.check_call([sys.executable, "-m", "pip", "uninstall", package])
+
+
 if __name__ == "__main__":
     pass
     # pip_install_development_package("devpack")