feat: add nix flake for devshell and publication of deepwork package

* Initial plan

* Add Nix flake, .envrc, and update documentation

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Enhance flake with apps output and improve README

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Add comprehensive Nix flake documentation

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Fix license definition and improve uv sync logic in flake

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Add missing jsonschema to development environment

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Enhance documentation with explicit GitHub flake reference examples

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Update validate workflow to use Nix development shell

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Add build job to validate flake package can be built

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Simplify Nix configuration in validate workflow

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Consolidate build into tests job after pytest

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* chore:

* chore: allow unfree packages in nixpkgs for BSL 1.1 license

* Fix Nix flake package to include Python with deepwork in PYTHONPATH

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Add deepwork hook CLI command for cleaner hook invocation

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Replace shell.nix with flake-compat wrapper

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Changes before error encountered

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Remove shell.nix and all references to nix-shell

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Remove final nix-shell reference from README

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Add rpds-py dependency to fix ModuleNotFoundError

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Document custom hooks and Python invocation with Nix flake

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Fix Python formatting with ruff

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Fix ruff linting issues: organize imports and fix exception handling

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Fix hook CLI to support custom module paths and remove invalid console.print parameter

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* Remove trailing whitespace in hook.py

Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>

* docs: explain auto-unfree license config in nix-flake.md

* docs: add dev env info to AGENTS.md

* docs: update nix-flake.md with recommended project configuration example

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: ncrmro <8276365+ncrmro@users.noreply.github.com>
Co-authored-by: Nicholas Romero <ncrmro@gmail.com>

Author: Copilot

.envrc

@@ -0,0 +1 @@
+use flake

.github/workflows/validate.yml

@@ -18,23 +18,27 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Install uv
-        uses: astral-sh/setup-uv@v4
-        with:
-          version: "latest"
+      - name: Install Nix
+        uses: cachix/install-nix-action@v31
 
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.11"
+      - name: Setup Nix development environment
+        uses: nicknovitski/nix-develop@v1
 
-      - name: Install dependencies
+      - name: Install Python dependencies
         run: uv sync --extra dev
 
       - name: Check formatting (ruff)
         run: |
-          uv run ruff format --check src/ tests/
-          uv run ruff check src/ tests/
+          ruff format --check src/ tests/
+          ruff check src/ tests/
 
       - name: Run tests
-        run: uv run pytest tests/ -v
+        run: pytest tests/ -v
+
+      - name: Build deepwork package
+        run: nix build
+
+      - name: Verify package output
+        run: |
+          ls -la result/bin/deepwork
+          ./result/bin/deepwork --version

.gitignore

@@ -66,6 +66,9 @@ dmypy.json
 *~
 .DS_Store
 
+# direnv
+.direnv/
+
 # Jupyter Notebook
 .ipynb_checkpoints
 

AGENTS.md

@@ -83,4 +83,22 @@ deepwork/
     ├── deepwork_jobs/              # ← Installed copy, NOT source of truth
     ├── deepwork_rules/             # ← Installed copy, NOT source of truth
     └── [bespoke_job]/              # ← Source of truth for bespoke only
+
+## Development Environment
+
+This project uses **Nix Flakes** to provide a reproducible development environment.
+
+### Using the Environment
+
+- **With direnv (Recommended)**: Just `cd` into the directory. The `.envrc` will automatically load the flake environment.
+- **Without direnv**: Run `nix develop` to enter the shell.
+- **Building**: Run `nix build` to build the package.
+
+**Note**: The flake is configured to automatically allow unfree packages (required for the BSL 1.1 license), so you do not need to set `NIXPKGS_ALLOW_UNFREE=1`.
+
+The environment includes:
+- Python 3.11
+- uv (package manager)
+- All dev dependencies (pytest, ruff, mypy, etc.)
+
 ```