Add Nix Dev Environment Support

Resolves #20

Author: jteppinette

.envrc

@@ -1 +1,6 @@
-layout pyenv $(cat runtimes.txt)
+if command -v pyenv >/dev/null 2>&1; then
+	layout pyenv $(cat runtimes.txt)
+elif command -v nix >/dev/null 2>&1; then
+	use flake
+	layout python python3.12
+fi

.github/workflows/pre-commit.yml

@@ -10,5 +10,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-      - uses: pre-commit/action@v2.0.0
+      - uses: DeterminateSystems/nix-installer-action@v3
+      - uses: DeterminateSystems/magic-nix-cache-action@main
+      - uses: HatsuneMiku3939/direnv-action@v1
+      - run: |
+          pip install -r requirements/pre-commit.txt
+          pre-commit run -a

.github/workflows/test.yml

@@ -8,16 +8,11 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
-    name: ${{ matrix.python-version }}
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.python-version }}
+      - uses: DeterminateSystems/nix-installer-action@v3
+      - uses: DeterminateSystems/magic-nix-cache-action@main
+      - uses: HatsuneMiku3939/direnv-action@v1
       - run: |
           pip install -r requirements/test.txt
-          pip install -e .
-          pytest
+          tox

.pre-commit-config.yaml

@@ -28,22 +28,28 @@ repos:
       - id: sort-simple-yaml # Sorts simple YAML files which consist only of top-level keys, preserving comments and blocks.
       - id: trailing-whitespace # This hook trims trailing whitespace.
 
-  - repo: https://github.com/psf/black
-    rev: 22.10.0
+  - repo: local
     hooks:
       - id: black
+        name: black
+        language: system
+        entry: black --check
+        types: [python]
 
-  - repo: https://github.com/timothycrosley/isort
-    rev: 5.12.0
-    hooks:
       - id: isort
+        name: isort
+        language: system
+        entry: isort --check
+        types: [python]
 
-  - repo: https://github.com/pycqa/flake8
-    rev: 6.0.0
-    hooks:
       - id: flake8
+        name: flake8
+        language: system
+        entry: flake8
+        types: [python]
 
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.991
-    hooks:
       - id: mypy
+        name: mypy
+        language: system
+        entry: mypy --ignore-missing-imports
+        types: [python]

README.md

@@ -234,7 +234,7 @@ This will cause all logs to have the `trace_id=123` pair regardless of including
 
 ### Required Software
 
-Refer to the links provided below to install these development dependencies:
+If you are using [nix](https://zero-to-nix.com/start/install/) & [direnv](https://direnv.net/docs/installation.html), then your dev environment will be managed automatically. Otherwise, you will need to manually install the following software:
 
 - [direnv](https://direnv.net)
 - [git](https://git-scm.com/)
@@ -244,8 +244,9 @@ Refer to the links provided below to install these development dependencies:
 
 **Setup**
 
+> If you are using pyenv, you will need to install the correct versions of python using `<runtimes.txt xargs -n 1 pyenv install -s`.
+
 ```sh
-$ <runtimes.txt xargs -n 1 pyenv install -s
 $ direnv allow
 $ pip install -r requirements/dev.txt
 $ pre-commit install

flake.lock

@@ -0,0 +1,26 @@
+{
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-24.11";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs =
+    { nixpkgs, flake-utils, ... }:
+    flake-utils.lib.eachDefaultSystem (
+      system:
+      let
+        pkgs = nixpkgs.legacyPackages.${system};
+      in
+      {
+        devShells.default = pkgs.mkShell {
+          packages = [
+            pkgs.python39
+            pkgs.python310
+            pkgs.python311
+            pkgs.python312
+          ];
+          shellHook = "unset PYTHONPATH";
+        };
+      }
+    );
+}

flake.nix

@@ -1,9 +1,5 @@
+-r ./pre-commit.txt
 -r ./publish.txt
+-r ./setuptools.txt
 -r ./test.txt
-black==22.10.0
-flake8==5.0.4
-isort==5.10.1
-mypy==0.991
-pre-commit==2.20.0
 pytest-watch==4.2.0
-tox==3.27.1

requirements/dev.txt

@@ -0,0 +1,5 @@
+black==22.10.0
+flake8==5.0.4
+isort==5.10.1
+mypy==0.991
+pre-commit==2.20.0

requirements/pre-commit.txt

@@ -1,2 +1,3 @@
+-r ./setuptools.txt
 build==0.7.0
 twine==3.8.0

requirements/publish.txt

@@ -0,0 +1 @@
+setuptools==75.8.0

requirements/setuptools.txt

@@ -1 +1,3 @@
+-r ./setuptools.txt
 pytest==7.2.0
+tox==3.27.1

requirements/test.txt

@@ -1 +1 @@
-3.9.10 3.10.1 3.11.9 3.12.3
+3.9 3.10 3.11 3.12