Merge pull request #178 from Maxteabag/nix-extras

Expose optional DB drivers in the Nix flake

Author: Maxteabag

flake.nix

@@ -28,53 +28,85 @@
         shortRev = if self ? shortRev then self.shortRev else "dirty";
         version = if tag != "" then tag else "0.0.0+${shortRev}";
 
-        sqlit = pyPkgs.buildPythonApplication {
-          pname = "sqlit";
-          inherit version;
-          pyproject = true;
+        # Extras mirror project.optional-dependencies in pyproject.toml,
+        # limited to drivers packaged in nixpkgs. Others (mssql-python,
+        # oracledb, mariadb, ibm_db, hdbcli, teradatasql, trino,
+        # presto-python-client, redshift-connector, clickhouse-connect,
+        # libsql, firebirdsql, pyathena, adbc-driver-flightsql) aren't
+        # here; install with `pipx inject` or a custom derivation.
+        nixpkgsExtras = {
+          ssh = [ pyPkgs.sshtunnel pyPkgs.paramiko ];
+          postgres = [ pyPkgs.psycopg2 ];
+          cockroachdb = [ pyPkgs.psycopg2 ];
+          mysql = [ pyPkgs.pymysql ];
+          duckdb = [ pyPkgs.duckdb ];
+          bigquery = [ pyPkgs.google-cloud-bigquery ];
+          snowflake = [ pyPkgs.snowflake-connector-python ];
+          d1 = [ pyPkgs.requests ];
+        };
 
-          src = self;
+        resolveExtras = names:
+          lib.concatLists (map (n:
+            nixpkgsExtras.${n} or (throw
+              "Unknown sqlit extra '${n}'. Available: ${
+                lib.concatStringsSep ", " (builtins.attrNames nixpkgsExtras)
+              }")
+          ) names);
 
-          build-system = [
-            pyPkgs.hatchling
-            pyPkgs."hatch-vcs"
-            pyPkgs."setuptools-scm"
-          ];
+        # Build sqlit, optionally with a set of driver extras from nixpkgs.
+        # Example:  makeSqlit { extras = [ "postgres" "ssh" ]; }
+        makeSqlit = { extras ? [] }:
+          pyPkgs.buildPythonApplication {
+            pname = "sqlit";
+            inherit version;
+            pyproject = true;
 
-          nativeBuildInputs = [
-            pyPkgs.pythonRelaxDepsHook
-          ];
+            src = self;
 
-          pythonRelaxDeps = [
-            "textual-fastdatatable"
-          ];
+            build-system = [
+              pyPkgs.hatchling
+              pyPkgs."hatch-vcs"
+              pyPkgs."setuptools-scm"
+            ];
 
-          SETUPTOOLS_SCM_PRETEND_VERSION = version;
+            nativeBuildInputs = [
+              pyPkgs.pythonRelaxDepsHook
+            ];
 
-          dependencies = [
-            pyPkgs.docker
-            pyPkgs.keyring
-            pyPkgs.pyperclip
-            pyPkgs.sqlparse
-            pyPkgs.textual
-            pyPkgs."textual-fastdatatable"
-          ];
+            pythonRelaxDeps = [
+              "textual-fastdatatable"
+            ];
 
-          pythonImportsCheck = [ "sqlit" ];
+            SETUPTOOLS_SCM_PRETEND_VERSION = version;
 
-          meta = with lib; {
-            description = "A terminal UI for SQL databases";
-            homepage = "https://github.com/Maxteabag/sqlit";
-            license = licenses.mit;
-            mainProgram = "sqlit";
+            dependencies = [
+              pyPkgs.docker
+              pyPkgs.keyring
+              pyPkgs.pyperclip
+              pyPkgs.sqlparse
+              pyPkgs.textual
+              pyPkgs."textual-fastdatatable"
+            ] ++ (resolveExtras extras);
+
+            pythonImportsCheck = [ "sqlit" ];
+
+            meta = with lib; {
+              description = "A terminal UI for SQL databases";
+              homepage = "https://github.com/Maxteabag/sqlit";
+              license = licenses.mit;
+              mainProgram = "sqlit";
+            };
           };
-        };
+
+        sqlit = makeSqlit { extras = builtins.attrNames nixpkgsExtras; };
       in {
         packages = {
           inherit sqlit;
           default = sqlit;
         };
 
+        lib = { inherit makeSqlit; };
+
         apps.default = {
           type = "app";
           program = "${sqlit}/bin/sqlit";