inital commit

Author: Cube707

.gitignore

@@ -0,0 +1,11 @@
+# Python Files
+/.venv/
+__pychache__/
+*.pyc
+
+# Build files:
+/build/
+/dist/
+*.egg-info/
+.eggs
+*.egg

.pre-commit-config.yaml

@@ -0,0 +1,38 @@
+---
+repos:
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - name: remove trailing whitespace
+        id: trailing-whitespace
+      - name: add newline to end of files
+        id: end-of-file-fixer
+      - name: sort requirements.txt
+        id: requirements-txt-fixer
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.10.1
+    hooks:
+      - name: sort python imports
+        id: isort
+
+  - repo: https://github.com/psf/black
+    rev: 22.6.0
+    hooks:
+      - name: re-format with black
+        id: black
+        language_version: python3
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 5.0.4
+    hooks:
+      - name: check syntax with flake8
+        id: flake8
+
+  - repo: https://github.com/asottile/setup-cfg-fmt
+    rev: v2.0.0
+    hooks:
+      - name: format setup.cfg
+        id: setup-cfg-fmt
+        args: [--include-version-classifiers]

LICENCE

@@ -0,0 +1,21 @@
+MIT Licence
+
+Copyright (c) 2022 Jan Wille
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,42 @@
+
+# makeclean.py
+
+A clean-up utility in python that removes files and folders. It is meant as a portable replacement for `rm -r` in `clean:` targets of makefiles, but
+can be used for other similar situations.
+
+It accepts an arbitrary number of path-objects and removes them if they exist, while ignoring non-existent ones.
+
+
+## Install
+
+Currently, the package is not release, so you have to install it from the repo.
+
+Install via pip:
+
+```bash
+pip install git+https://github.com/Cube707/python-makeclean
+```
+
+
+## Usage
+
+You can use it directly from the terminal:
+
+```bash
+makeclean foo.txt bar/
+```
+
+But it gets really helpful if you use it as the `clean:` target of a makefile, making it fully portable:
+
+```makefile
+TRASH = foo.txt bar/
+
+clean:
+    makeclean $(TRASH)
+```
+
+Use `makeclean --help` for more details.
+
+---
+
+*Copyright 2022 Jan Wille*

requirements.txt

@@ -0,0 +1,3 @@
+click
+pre-commit
+wheel

setup.cfg

@@ -0,0 +1,53 @@
+[metadata]
+version = attr: makeclean.__version__
+description = remove lists of files and folders
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/Cube707/python-makeclean
+author = Jan Wille
+author_email = [email protected]
+license = MIT
+license_files = LICENCE
+classifiers =
+    Development Status :: 3 - Alpha
+    Environment :: Console
+    Intended Audience :: Developers
+    License :: OSI Approved :: MIT License
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3 :: Only
+    Programming Language :: Python :: 3.10
+    Topic :: Software Development :: Build Tools
+keywords =
+    make
+    makefiles
+    cleanup
+project_urls =
+    Download = https://pypi.org/project/makeclean/#files
+    Bug Tracker = https://github.com/Cube707/python-makeclean/issues
+    Source Code = https://github.com/Cube707/python-makeclean
+
+[options]
+python_requires = >=3.10
+package_dir =
+    = src
+install_requires =
+    click
+    setuptools
+    wheel
+
+[options.entry_points]
+console_scripts =
+    makeclean = makeclean:main
+
+[flake8]
+max-complexity = 12
+max-line-length = 88
+exclude =
+    __pycache__/
+    .git/
+    .venv/
+
+[isort]
+profile = black
+src_paths = src
+lines_after_imports = 2

setup.py

@@ -0,0 +1,7 @@
+from setuptools import setup
+
+
+setup(
+    # name is here to make GitHubs dependency displayer happy
+    name="makeclean"
+)

src/makeclean/__init__.py

@@ -0,0 +1,48 @@
+from os import PathLike, remove
+from os.path import exists, isdir
+from shutil import rmtree
+
+import click
+
+
+__version__ = "0.0.1-dev0"
+
+
+@click.command()
+@click.help_option("--help", "-h")
+@click.option("--verbose", "-v", is_flag=True, default=False)
+@click.option("--version", "-V", is_flag=True, default=False)
+@click.argument("PATH", nargs=-1, type=click.Path())
+def main(path, verbose, version):
+    """This utility is meant for use in makefiles as the clean target or similar usecases.
+    It takes an arbitray number of PATH objects and removes them if they exists.
+    Folders will be remove recursivly."""
+    if version:
+        print(f"makeclean.py v{__version__}")
+        return
+    clean(path, verbose)
+
+
+def clean(path: list[str|PathLike], verbose=False):
+    """Removes all given Path-Objects, meaning files are deleted and
+    directorys are removed recurlivly.
+
+    Args:
+        `path` (list[str|PathLike]): List of Paths to delete.
+        `verbose` (bool, optional): If set to `True`, prints informations to the screen.
+    """
+    for p in path:
+        if not exists(p):
+            if verbose:
+                click.echo(f'{click.style("skip", fg="yellow")}: {p}')
+            continue
+        if isdir(p):
+            if not p.endswith("/"):
+                p += "/"
+            if verbose:
+                click.echo(f'{click.style("dir", fg="bright_cyan")}:  {p}')
+            rmtree(p)
+        else:
+            if verbose:
+                click.echo(f'{click.style("file", fg="blue")}: {p}')
+            remove(p)

src/makeclean/__main__.py

@@ -0,0 +1,5 @@
+from . import main
+
+
+if __name__ == "__main__":
+    main()