Merge pull request #12 from stackabletech/feat/nixify

Add nix build configs

Author: NickLarsenNZ

.gitignore

@@ -1,5 +1,6 @@
 .env
 build
 dist
+result
 src/beku_stackabletech.egg-info
 examples/suites/tests/_work

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## Added
+
+- Nix build files ([#12])
+
+[#12]: https://github.com/stackabletech/beku.py/pull/12
+
 ## [0.0.9] - 2023-08-23
 
 ### Added

README.md

@@ -6,28 +6,59 @@ Version: 0.0.9
 
 We recommend to use [pipx](https://pypa.github.io/pipx/):
 
-    pipx install beku-stackabletech
+```sh
+pipx install beku-stackabletech
+```
 
 But you can also use `pip`:
 
-    # from PyPI
-    pip install beku-stackabletech
-    # from GitHub
-    pip install git+https://github.com/stackabletech/beku.py.git@master
+```sh
+# from PyPI
+pip install beku-stackabletech
+# from GitHub
+pip install git+https://github.com/stackabletech/beku.py.git@master
+```
+
+Or via NixOS and Nix Shell:
+
+```nix
+{ lib, pkgs, ... }:
+with lib;
+let
+  beku = pkgs.callPackage(pkgs.fetchFromGitHub {
+    owner = "stackabletech";
+    repo = "beku.py";
+    rev = "145e8210f5786b8128e3af43f60b61f065cc2c39";
+    hash = "sha256-hLaIY4BE+VIMeKmS3JLOZy87OC2VuQtbX/NCIbQr2p4="; # use lib.fakeHash to find new hashes when upgrading
+  } + "/beku.nix") {};
+in
+{
+  packages = with pkgs; [
+    beku
+    # ...
+  ];
+
+  // ...
+}
+```
 
 ## Usage
 
-    cd <stackable operator directory>
-    rm -rf tests/_work && beku
-    cd tests/_work && kubectl kuttl test
+```sh
+cd <stackable operator directory>
+rm -rf tests/_work && beku
+cd tests/_work && kubectl kuttl test
+```
 
 Also see the `examples` folder.
 
 ## Description
 
 Fast Kuttl tests expander for Stackable integration tests.
 
-    beku -i tests/test-definition.yaml -t tests/templates/kuttl -k tests/kuttl-test.yaml.jinja2 -o tests/_work
+```sh
+beku -i tests/test-definition.yaml -t tests/templates/kuttl -k tests/kuttl-test.yaml.jinja2 -o tests/_work
+```
 
 ## Release a new version
 
@@ -41,6 +72,8 @@ Update the CHANGELOG.
 Commit and tag.
 Build and publish:
 
-    rm -rf dist/
-    python -m build --wheel .
-    twine upload dist/*
+```sh
+rm -rf dist/
+python -m build --wheel .
+twine upload dist/*
+```

beku.nix

@@ -0,0 +1,23 @@
+{ python3 }:
+
+python3.pkgs.buildPythonApplication {
+  pname = "beku-stackabletech";
+  version = "0.0.9";
+
+  format = "pyproject";
+
+  src = builtins.path {
+    path = ./.;
+    name = "beku-stackabletech";
+  };
+
+  nativeBuildInputs = [
+    python3.pkgs.setuptools
+  ];
+
+  propagatedBuildInputs = [
+    python3.pkgs.jinja2
+    python3.pkgs.pyyaml
+  ];
+}
+

default.nix

@@ -0,0 +1,5 @@
+{ pkgs ? import <nixpkgs> {} }:
+
+{
+  beku = pkgs.callPackage ./beku.nix {};
+}