Merge pull request #124 from Preocts/preocts

Replace Makefile with noxfile config

Author: Preocts

Makefile

@@ -65,68 +65,42 @@ the desired version while creating the `venv`. (e.g. `python3` or `python3.8`)
 
 ## Installation steps
 
-### Makefile
-
-This repo has a Makefile with some quality of life scripts if the system
-supports `make`.  Please note there are no checks for an active `venv` in the
-Makefile.  If you are on Windows you can install make using scoop or chocolatey.
-
-| PHONY         | Description                                                           |
-| ------------- | --------------------------------------------------------------------- |
-| `install-dev` | install development/test requirements and project as editable install |
-| `update-dev`  | regenerate requirements-*.txt (will keep existing pins)               |
-| `upgrade-dev` | attempt to update all dependencies, regenerate requirements-*.txt     |
-| `coverage`    | Run tests with coverage, generate console report                      |
-| `docker-test` | Run coverage and tests in a docker container.                         |
-| `build-dist`  | Build source distribution and wheel distribution                      |
-| `clean`       | Deletes build, nox, coverage, pytest, mypy, cache, and pyc artifacts  |
-
-
 Clone this repo and enter root directory of repo:
 
 ```console
-$ git clone https://github.com/[ORG NAME]/[REPO NAME]
-$ cd [REPO NAME]
+git clone https://github.com/[ORG NAME]/[REPO NAME]
+cd [REPO NAME]
 ```
 
-
 Create the `venv`:
 
 ```console
-$ python -m venv venv
+python -m venv venv
 ```
 
 Activate the `venv`:
 
 ```console
 # Linux/Mac
-$ . venv/bin/activate
+. venv/bin/activate
 
 # Windows
-$ venv\Scripts\activate
+venv\Scripts\activate
 ```
 
 The command prompt should now have a `(venv)` prefix on it. `python` will now
 call the version of the interpreter used to create the `venv`
 
 Install editable library and development requirements:
 
-### With Makefile:
-
 ```console
-make install-dev
-```
-
-### Without Makefile:
-
-```console
-$ python -m pip install --editable .[dev,test]
+python -m pip install --editable .[dev,test]
 ```
 
 Install pre-commit [(see below for details)](#pre-commit):
 
 ```console
-$ pre-commit install
+pre-commit install
 ```
 
 ---
@@ -136,33 +110,32 @@ $ pre-commit install
 Run pre-commit on all files:
 
 ```console
-$ pre-commit run --all-files
+pre-commit run --all-files
 ```
 
 Run tests (quick):
 
 ```console
-$ pytest
+pytest
 ```
 
-Run tests (slow):
+Run tests:
 
 ```console
-$ nox
+nox
 ```
 
 Build dist:
 
 ```console
-$ python -m pip install --upgrade build
-
-$ python -m build
+python -m pip install --upgrade build
+python -m build
 ```
 
 To deactivate (exit) the `venv`:
 
 ```console
-$ deactivate
+deactivate
 ```
 
 ---
@@ -176,22 +149,6 @@ generated `requirements-*.txt` files.
 
 Once updated following the steps below, the package can be installed if needed.
 
-### With Makefile
-
-To update the generated files with a dependency:
-
-```console
-make update-dev
-```
-
-To attempt to upgrade all generated dependencies:
-
-```console
-make upgrade-dev
-```
-
-### Without Makefile
-
 To update the generated files with a dependency:
 
 ```console
@@ -200,13 +157,7 @@ pip-compile --no-emit-index-url requirements/requirements-dev.in
 pip-compile --no-emit-index-url requirements/requirements-test.in
 ```
 
-To attempt to upgrade all generated dependencies:
-
-```console
-pip-compile --upgrade --no-emit-index-url requirements/requirements.in
-pip-compile --upgrade --no-emit-index-url requirements/requirements-dev.in
-pip-compile --upgrade --no-emit-index-url requirements/requirements-test.in
-```
+To attempt to upgrade all generated dependencies add the `--upgrade` flag.
 
 ---
 

README.md

@@ -1,9 +1,44 @@
 from __future__ import annotations
 
+import os
+import sys
+
 import nox
 
+# Control factors for finding pieces of the module
 MODULE_NAME = "module_name"
-COVERAGE_FAIL_UNDER = "--fail-under=50"
+TESTS_PATH = "tests"
+COVERAGE_FAIL_UNDER = 50
+REQUIREMENT_IN_FILES = [
+    os.path.join("requirements", "requirements.in"),
+    os.path.join("requirements", "requirements-dev.in"),
+    os.path.join("requirements", "requirements-test.in"),
+]
+
+# What are we allowed to clean (delete)?
+CLEAN_DIRS = [
+    "__pycache__",
+    ".mypy_cache",
+    ".pytest_cache",
+    ".coverage",
+    ".nox",
+    "dist",
+    "build",
+]
+CLEAN_FILES = [
+    "*.pyc",
+    "*.pyo",
+    "coverage.json",
+    ".coverage.*",
+]
+
+
+# Define the default sessions run when `nox` is called on the CLI
+nox.options.sessions = [
+    "tests_with_coverage",
+    "coverage_combine_and_report",
+    "mypy_check",
+]
 
 
 @nox.session(
@@ -14,17 +49,19 @@ def tests_with_coverage(session: nox.Session) -> None:
     print_standard_logs(session)
 
     session.install(".[test]")
-    session.run("coverage", "run", "-p", "-m", "pytest", "tests/")
+    session.run("coverage", "run", "-p", "-m", "pytest", TESTS_PATH)
 
 
 @nox.session()
 def coverage_combine_and_report(session: nox.Session) -> None:
     """Combine all coverage partial files and generate JSON report."""
     print_standard_logs(session)
 
+    fail_under = f"--fail-under={COVERAGE_FAIL_UNDER}"
+
     session.install(".[test]")
     session.run("python", "-m", "coverage", "combine")
-    session.run("python", "-m", "coverage", "report", "-m", COVERAGE_FAIL_UNDER)
+    session.run("python", "-m", "coverage", "report", "-m", fail_under)
     session.run("python", "-m", "coverage", "json")
 
 
@@ -38,6 +75,69 @@ def mypy_check(session: nox.Session) -> None:
     session.run("mypy", "-p", MODULE_NAME, "--no-incremental")
 
 
+@nox.session(python=False)
+def coverage(session: nox.Session) -> None:
+    """Generate a coverage report. Does not use a venv."""
+    session.run("coverage", "erase")
+    session.run("coverage", "run", "-m", "pytest", TESTS_PATH)
+    session.run("coverage", "report", "-m")
+
+
+@nox.session(python=False)
+def docker(session: nox.Session) -> None:
+    """Run tests in a docker container. Requires docker damon running."""
+    session.run("docker", "build", "-t", "pydocker-test", ".")
+    session.run("docker", "run", "-it", "--rm", "pydocker-test")
+
+
+@nox.session()
+def build(session: nox.Session) -> None:
+    """Build distrobution files."""
+    print_standard_logs(session)
+
+    session.install("build")
+    session.run("python", "-m", "build")
+
+
+@nox.session()
+def update(session: nox.Session) -> None:
+    """Process requirement*.in files, updating only additions/removals."""
+    print_standard_logs(session)
+
+    session.install("pip-tools")
+    for filename in REQUIREMENT_IN_FILES:
+        session.run("pip-compile", "--no-emit-index-url", filename)
+
+
+@nox.session()
+def upgrade(session: nox.Session) -> None:
+    """Process requirement*.in files and upgrade all libraries as possible."""
+    print_standard_logs(session)
+
+    session.install("pip-tools")
+    for filename in REQUIREMENT_IN_FILES:
+        session.run("pip-compile", "--no-emit-index-url", "--upgrade", filename)
+
+
+@nox.session(python=False)
+def clean(session: nox.Session) -> None:
+    """Clean cache, .pyc, .pyo, and artifact files from project."""
+    if sys.platform.startswith("win"):
+        print("Windows unsupported at this time.")
+        return None
+
+    elif sys.platform in ["linux", "darwin"]:
+        for dirpath in CLEAN_DIRS:
+            session.run("find", ".", "-name", dirpath, "-exec", "rm", "-rf", "{}", "+")
+
+        for file in CLEAN_FILES:
+            session.run("find", ".", "-name", file, "-exec", "rm", "-f", "{}", "+")
+
+    else:
+        print("Unknown OS for this session.")
+        return None
+
+
 def print_standard_logs(session: nox.Session) -> None:
     """Reusable output for monitoring environment factors."""
     version = session.run("python", "--version", silent=True)