Restructure packages into subdirectories

nixos-module.nix

@@ -1,70 +1,56 @@
-{ pkgs , ... } :
+{ pkgs } :
 
 with pkgs ;
-with pkgs . kernelmaft ;
 
 {
+	imports = [
+		packages/bookwyrm/nixos-module.nix
+	] ;
+
 	nixpkgs = {
 		overlays = [
-			( self : super :
-				{
-					kernelmaft = {
+			( self : super : {
+				kernelmaft = {
 
-						bookwyrm = callPackage (
-							import ./bookwyrm.nix
+					bookwyrm = callPackage (
+						import ./bookwyrm.nix
+					) {} ;
+
+					python = {
+
+						bw-file-resubmit = callPackage (
+							import ./python3.11-bw-file-resubmit.nix
 						) {} ;
 
-						python = {
+						django-imagekit = callPackage (
+							import ./python3.11-django-imagekit.nix
+						) {} ;
 
-							bw-file-resubmit = callPackage (
-								import ./python3.11-bw-file-resubmit.nix
-							) {} ;
+						django-pgtrigger = callPackage (
+							import ./python3.11-django-pgtrigger.nix
+						) {} ;
 
-							django-imagekit = callPackage (
-								import ./python3.11-django-imagekit.nix
-							) {} ;
+						django-sass-processor = callPackage (
+							import ./python3.11-django-sass-processor.nix
+						) {} ;
 
-							django-pgtrigger = callPackage (
-								import ./python3.11-django-pgtrigger.nix
-							) {} ;
-
-							django-sass-processor = callPackage (
-								import ./python3.11-django-sass-processor.nix
-							) {} ;
-
-							s3-tar = callPackage (
-								import ./python3.11-s3-tar.nix
-							) {} ;
-
-						} ;
+						s3-tar = callPackage (
+							import ./python3.11-s3-tar.nix
+						) {} ;
 
 					} ;
 
-					# TODO: Use the following template once the custom Python packages have been converted to use `buildPythonPackage`
-        	#
-        	# python311 = super . python311 . override {
-        	#   packageOverrides = python-self : python-super : {
-        	#     package-name = super . callPackage ( import ./package-file.nix ) {} ;
-        	#   } ;
-        	# } ;
+				} ;
 
-				}
-			)
+				# TODO: Use the following template once the custom Python packages have been converted to use `buildPythonPackage`
+      	#
+      	# python311 = super . python311 . override {
+      	#   packageOverrides = python-self : python-super : {
+      	#     package-name = super . callPackage ( import ./package-file.nix ) {} ;
+      	#   } ;
+      	# } ;
+
+			} )
 		] ;
 	} ;
-
-	systemd = {
-		units = {
-			"bookwyrm.service" = {
-				text = ''
-					[Unit]
-					After=network.target
-
-					[Service]
-					ExecStart=${bookwyrm}/bin/bookwyrm
-					WorkingDirectory=/var/lib/bookwyrm
-				'' ;
-			} ;
-		} ;
-	} ;
 }

packages/bookwyrm/nixos-module.nix

@@ -0,0 +1,20 @@
+{ pkgs } :
+
+with pkgs . kernelmaft ;
+
+{
+	systemd = {
+		units = {
+			"bookwyrm.service" = {
+				text = ''
+					[Unit]
+					After=network.target
+
+					[Service]
+					ExecStart=${bookwyrm}/bin/bookwyrm
+					WorkingDirectory=/var/lib/bookwyrm
+				'' ;
+			} ;
+		} ;
+	} ;
+}

readme.md

@@ -3,11 +3,28 @@
 ## Description
 
 An assortment of Nix packages not in the official collection.
-They can either be imported individually or using the module if you're on NixOS.
+They can either be used individually or, if you're on NixOS, imported wholesale using the top-level module.
 
 These are purposefully written without support for [overriding](https://nixos.org/guides/nix-pills/17-nixpkgs-overriding-packages) in order to minimise complexity.
 If you want to build upon them I encourage you to fork this repository.
 
+## Structure
+
+### `nixos-module.nix`
+
+The top-level NixOS module containing all package expressions as an overlay, and all package modules.
+Once imported the overlay contents can be found under `pkgs . kernelmaft`.
+
+### `packages/<package-name>/package.nix`
+
+A Nix package expression.
+
+### `packages/<package-name>/nixos-module.nix`
+
+NixOS module providing additional features for the package in question, such as for example systemd units.
+Can be imported directly, but is also imported by the top-level module.
+Not present for all packages.
+
 ## Examples
 
 > **Note:**
@@ -18,8 +35,8 @@ Using a specific package:
 
 ```nix
 pkgs . callPackage ( import ( pkgs . fetchurl {
-	url = "https://kernelmaft.com/forgejo/zedfrigg/nix-packages/raw/commit/c45884c66f31f8d8d80866bebc13e9e963e02a70/python3.11-django-imagekit.nix" ;
-	hash = "sha256-E4mo2JvK5SuxC6SQ7O5ZjhzehmxEThNJ7F6gBnil8ho=" ;
+	url = "https://kernelmaft.com/forgejo/zedfrigg/nix-packages/raw/commit/c45884c66f31f8d8d80866bebc13e9e963e02a70/packages/python3.11-django-imagekit/package.nix" ;
+	hash = "sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=" ;
 } ) ) {}
 ```