bring in python devshell with Nix

Makefile

@@ -9,13 +9,6 @@ define target_success
 	@printf "\033[32m==> Target \"$(1)\" passed\033[0m\n\n"
 endef
 
-define try_run_sbomnix
-@if ! source scripts/env.sh && sbomnix -h 2>/dev/null; then \
-	echo "\033[31mError:\033[0m failed to run sbomnix, maybe it's not in your PATH?"; \
-	exit 1; \
-fi
-endef
-
 .DEFAULT_GOAL := help
 
 TARGET: ## DESCRIPTION
@@ -24,57 +17,28 @@ TARGET: ## DESCRIPTION
 help: ## Show this help message
 	@grep -E '^[a-zA-Z_-]+:.*?##.*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}'
 
-install: ## Install sbomnix
-	pip install --user .
-	$(call try_run_sbomnix,$@)
-	$(call target_success,$@)
-
-install-dev: uninstall install-dev-requirements ## Install for development
-	pip install --editable .
-	$(call try_run_sbomnix,$@)
+pre-push: test format check  ## Run tests, black, and flake checks
 	$(call target_success,$@)
 
-uninstall: ## Uninstall sbomnix
-	find . -name '*.egg-info' -exec rm -fr {} +
-	pip uninstall -y sbomnix 
+test-ci: check  ## Run CI tests
+	pytest -vx -k "not skip_in_ci" tests/
 	$(call target_success,$@)
 
-install-dev-requirements: clean ## Install all requirements
-	pip install -q -r requirements.txt --no-cache-dir
-	$(call target_success,$@)
-
-pre-push: test black style pylint reuse-lint  ## Run tests, pycodestyle, pylint, reuse-lint
-	$(call target_success,$@)
+check: clean
+	nix --extra-experimental-features flakes flake check
 
-test-ci: install-dev-requirements style pylint reuse-lint  ## Run CI tests
-	source scripts/env.sh && pytest -vx -k "not skip_in_ci" tests/
+test: ## Run tests
+	pytest -vx tests/
 	$(call target_success,$@)
 
-test: install-dev-requirements ## Run tests
-	source scripts/env.sh && pytest -vx tests/
-	$(call target_success,$@)
-
-black: clean ## Reformat with black
+format: clean ## Reformat with black
 	@for py in $(PYTHON_TARGETS); \
 		do echo "$$py:"; \
 		black -q $$py; \
 	done
 	$(call target_success,$@)
 
-style: clean ## Check with pycodestyle (pep8)
-	pycodestyle --max-line-length 90 $(PYTHON_TARGETS)
-	$(call target_success,$@)
-
-pylint: clean ## Check with pylint
-	pylint --disable duplicate-code -rn $(PYTHON_TARGETS) || exit 1
-	$(call target_success,$@)
-
-reuse-lint: clean ## Check with reuse lint
-	reuse lint
-	$(call target_success,$@)
-
-release-asset: clean install-dev-requirements ## Build release asset
-	nix build
+release-asset: clean ## Build release asset
 	nix-shell -p nix-info --run "nix-info -m"
 	nix-env -qa --meta --json -f $(shell nix-shell -p nix-info --run "nix-info -m" | grep "nixpkgs: " | cut -d'`' -f2) '.*' >meta.json
 	mkdir -p build/

README.md

@@ -71,12 +71,22 @@ $ cd sbomnix
 $ nix-shell
 ```
 
-From the development shell, run `sbomnix` as follows:
+Keep in mind this doesn't add the various entrypoint binaries to your `PATH`
+directly. They are produced during the setuptools build.
+
+While you're in the devshell, you can run run `sbomnix` via the entrypoint file
+directly:
+
 ```bash
-$ sbomnix --help
+$ sbomnix/main.py --help
 ```
 
 ## Usage Examples
+The usage examples work for both the built package, as well as inside the devshell.
+
+Keep in mind inside the devshell, calls to `sbomnix` need to be replaced with
+`sbomnix/main.py` (and similar for other entrypoints).
+
 In the below examples, we use Nix package `wget` as an example target.
 To print `wget` out-path on your local system, try:
 ```bash

flake.nix

@@ -17,14 +17,6 @@
       url = "github:nix-community/flake-compat";
       flake = false;
     };
-    nix-fast-build = {
-      url = "github:Mic92/nix-fast-build";
-      # re-use some existing inputs
-      inputs = {
-        flake-parts.follows = "flake-parts";
-        treefmt-nix.follows = "treefmt-nix";
-      };
-    };
     nix-visualize = {
       url = "github:craigmbooth/nix-visualize";
       flake = false;

nix/checks.nix

@@ -13,12 +13,29 @@
         # todo this could be moved into a shared flake
         reuse =
           pkgs.runCommandLocal "reuse-lint" {
-            buildInputs = [pkgs.reuse];
+            nativeBuildInputs = [pkgs.reuse];
           } ''
             cd ${../.}
             reuse lint
             touch $out
           '';
+        pycodestyle =
+          pkgs.runCommandLocal "pycodestyle" {
+            nativeBuildInputs = [pkgs.python3.pkgs.pycodestyle];
+          } ''
+            cd ${../.}
+            pycodestyle --max-line-length 90 $(find . -name "*.py" ! -path "*venv*" ! -path "*eggs*")
+            touch $out
+          '';
+        pylint =
+          pkgs.runCommandLocal "pylint" {
+            nativeBuildInputs = [self'.packages.python pkgs.python3.pkgs.pylint];
+          } ''
+            cd ${../.}
+            export HOME=/tmp
+            pylint --disable duplicate-code -rn $(find . -name "*.py" ! -path "*venv*" ! -path "*eggs*")
+            touch $out
+          '';
       }
       //
       # merge in the package derivations to force a build of all packages during a `nix flake check`

nix/devshell.nix

@@ -4,58 +4,39 @@
 {
   perSystem = {
     pkgs,
-    inputs',
     self',
     ...
   }: {
-    devShells.default = let
-      pp = pkgs.python3Packages;
-    in
-      pkgs.mkShell rec {
-        name = "sbomnix-dev-shell";
+    devShells.default = pkgs.mkShell rec {
+      name = "sbomnix-dev-shell";
 
-        buildInputs =
-          (with pkgs; [
-            coreutils
-            curl
-            gnugrep
-            gnused
-            graphviz
-            grype
-            gzip
-            nix
-            reuse
-          ])
-          ++ (with self'.packages; [
-            vulnix
-            nix-visualize
-          ])
-          ++ (with pp; [
-            beautifulsoup4
-            colorlog
-            graphviz
-            numpy
-            packageurl-python
-            packaging
-            pandas
-            requests
-            requests-cache
-            tabulate
-            venvShellHook
-            wheel
-          ])
-          ++ [inputs'.nix-fast-build.packages.default];
+      packages =
+        (with pkgs; [
+          coreutils
+          curl
+          gnugrep
+          gnused
+          graphviz
+          grype
+          gzip
+          nix
+          black
+          reuse
+        ])
+        ++ (with self'.packages; [
+          nix-visualize
+          python # that python with all sbomnix [dev-]dependencies
+          vulnix
+        ]);
 
-        venvDir = "venv";
-        postShellHook = ''
-          source $PWD/scripts/env.sh
-
-          # https://github.com/NixOS/nix/issues/1009:
-          export TMPDIR="/tmp"
-
-          # Enter python development environment
-          make install-dev
-        '';
-      };
+      # Add the repo root to PYTHONPATH, so invoking entrypoints (and them being
+      # able to find the python packages in the repo) becomes possible.
+      # `pytest.ini` already sets this for invoking `pytest`
+      # (cascading down to the processes it spawns), but this is for the developer
+      # invoking entrypoints from inside the devshell.
+      shellHook = ''
+        export PYTHONPATH="$PYTHONPATH:$(pwd)"
+      '';
+    };
   };
 }