Use Nix

Author: Kaweees

.justfile

@@ -43,7 +43,3 @@ check:
 # Add scripts
 add_scripts:
   uv add --script scripts/this.py 'typer>=0.12.5'
-
-# Build dockerfile for DAG
-build target:
-  docker build -t packages/{{target}} --build-arg PACKAGE={{target}} .

README.md

@@ -31,7 +31,7 @@ A web dashboard for training machine learning models with PyTorch.
 [![Python][Python-shield]][Python-url]
 [![Pytest][Pytest-shield]][Pytest-url]
 [![Codecov][Codecov-shield]][Codecov-url]
-[![Docker][Docker-shield]][Docker-url]
+[![NixOS][NixOS-shield]][NixOS-url]
 [![GitHub Actions][github-actions-shield]][github-actions-url]
 
 <!-- GETTING STARTED -->
@@ -56,6 +56,7 @@ To get a local copy of the project up and running on your machine, follow these
 2. Install the virtual environment and pre-commit hooks
 
    ```sh
+   nix-shell
    just install
    ```
 
@@ -73,6 +74,8 @@ To get a local copy of the project up and running on your machine, follow these
    just run <package_name>
    ```
 
+   The dashboard will be available at `http://localhost:8000`.
+
 <!-- PROJECT FILE STRUCTURE -->
 
 ## Project Structure
@@ -113,8 +116,8 @@ The source code for this project is distributed under the terms of the MIT Licen
 [Python-url]: https://www.python.org/
 [Pytest-shield]: https://img.shields.io/badge/pytest-%23008080.svg?style=for-the-badge&logo=pytest&logoColor=2F9FE3&labelColor=222222&color=2F9FE3
 [Pytest-url]: https://docs.pytest.org
-[Docker-shield]: https://img.shields.io/badge/docker-%232671E5.svg?style=for-the-badge&logo=docker&logoColor=1D63ED&labelColor=222222&color=1D63ED
-[Docker-url]: https://www.docker.com/
+[NixOS-shield]: https://img.shields.io/badge/NIX-%23008080.svg?style=for-the-badge&logo=NixOS&logoColor=5277C3&labelColor=222222&color=5277C3
+[NixOS-url]: https://nixos.org/
 [Codecov-shield]: https://img.shields.io/badge/codecov-%23008080.svg?style=for-the-badge&logo=codecov&logoColor=FF0077&labelColor=222222&color=FF0077
 [Codecov-url]: https://codecov.io/
 [github-actions-shield]: https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=2671E5&labelColor=222222&color=2671E5

pyproject.toml

@@ -64,7 +64,19 @@ skips = ['B101']
 
 [tool.ruff]
 lint.ignore = ["E501"]
-extend-exclude = ["__pycache__", "docs", "site", ".tmp"]
+extend-exclude = [
+  "__pycache__",
+  "docs",
+  "site",
+  ".eggs",
+  ".git",
+  ".venv",
+  "build",
+  "dist",
+  "notebooks",
+  ".cache",
+]
+line-length = 100
 
 [tool.pytest.ini_options]
 cache_dir = ".pytest_cache"

shell.nix

@@ -0,0 +1,12 @@
+{ pkgs ? import <nixpkgs> { } }:
+
+pkgs.mkShell {
+  buildInputs = [
+    pkgs.just # Just
+    pkgs.uv # Python package manager
+    pkgs.python311 # Python 3.11
+  ];
+
+  # Shell hook to set up environment
+  shellHook = "";
+}