Merge pull request #154 from Preocts/preocts-nox

Add install session for noxfile

Author: Preocts

README.md

@@ -114,6 +114,15 @@ python -m pip install --editable .[dev,test]
 pre-commit install
 ```
 
+### Install with nox
+
+If you have `nox` installed with `pipx` or in the current venv you can use the
+following session. This is an alternative to the two steps above.
+
+```console
+nox -s install
+```
+
 ---
 
 ## Pre-commit and nox tools

noxfile.py

@@ -1,14 +1,19 @@
 from __future__ import annotations
 
+import os
 import pathlib
 import shutil
+import sys
 
 import nox
 
 # Control factors for finding pieces of the module
 MODULE_NAME = "module_name"
 TESTS_PATH = "tests"
 COVERAGE_FAIL_UNDER = 50
+VENV_PATH = "venv"
+WINDOWS_PYTHON = "py"
+LINUX_PYTHON = "python3"
 REQUIREMENT_IN_FILES = [
     pathlib.Path("requirements/requirements.in"),
     pathlib.Path("requirements/requirements-dev.in"),
@@ -97,6 +102,32 @@ def build(session: nox.Session) -> None:
     session.run("python", "-m", "build")
 
 
+@nox.session(python=False)
+def install(session: nox.Session) -> None:
+    """Setup a development environment. Uses active venv if available, builds one if not."""
+    # Use the active environement if it exists, otherwise create a new one
+    venv_path = os.environ.get("VIRTUAL_ENV", VENV_PATH)
+
+    if sys.platform == "win32":
+        py_command = "py"
+        venv_path = f"{venv_path}/Scripts"
+        activate_command = f"{venv_path}/activate"
+    else:
+        py_command = "python3"
+        venv_path = f"{venv_path}/bin"
+        activate_command = f"source {venv_path}/activate"
+
+    if not os.path.exists(VENV_PATH):
+        session.run(py_command, "-m", "venv", VENV_PATH)
+        session.run(f"{venv_path}/python", "-m", "pip", "install", "--upgrade", "pip")
+
+    session.run(f"{venv_path}/python", "-m", "pip", "install", "-e", ".[dev,test]")
+    session.run(f"{venv_path}/pre-commit", "install")
+
+    if not os.environ.get("VIRTUAL_ENV"):
+        session.log(f"\n\nRun '{activate_command}' to enter the virtual environment.\n")
+
+
 @nox.session()
 def update(session: nox.Session) -> None:
     """Process requirement*.in files, updating only additions/removals."""