Add nix flake and convert to modern pyproject

Author: patrickjeremic

.gitignore

@@ -0,0 +1 @@
+*.egg-info

MANIFEST.in

@@ -5,22 +5,24 @@ Xfer is a utility to allow out-of-band sending of arbitrary data, using animated
 ## Installation
 
 1. Clone the repository
-2. Run `pip install -r requirements.txt` (may be `pip3`, in place of `pip`, depending on your OS).
+2. Install with `pip install .`
+3. Run the CLI with `xfer --help`
 
 ## Workflow
+
 The workflow looks something like this:
 
-1. Alice runs Xfer on their local machine, as such: `cat 'This is a message to send' | python3 xfer.py write --outfile send.gif`
-2. Alice opens `send.gif` and records the output on a mobile device. 
+1. Alice runs Xfer on their local machine, as such: `echo 'This is a message to send' | xfer write --outfile send.gif`
+2. Alice opens `send.gif` and records the output on a mobile device.
 3. Alice send a message, via a third party service, such as Signal, to Bob.
-4. Bob runs `python3 xfer.py read` on his laptop.
+4. Bob runs `xfer read` on his laptop.
 5. Bob plays the recording of the animated gif, and captures the video on their laptop's webcam.
 6. Once Xfer has captured all the individual frames, it will output the original message on Bob's screen.
- 
+
 ## How it works
 
 1. `xfer write` breaks the source message down into chunks. By default these are 256 byte chunks. This is not supported as a flag, because the relationship between chunk size and QR code dimensions are not clear. The values can be seen at the top of the `xfer` script, but should not be changed unless you know what you are doing!
-2. Each chunk is then encoded to a static QR code, with it's frame number for reassembly. 
+2. Each chunk is then encoded to a static QR code, with it's frame number for reassembly.
 3. A keyframe is added to the start of the sequence, to instruct the receiving application on the number of frames it should expect.
 4. The collection of static images is then compiled into an animated GIF.
 
@@ -31,7 +33,7 @@ The workflow looks something like this:
 ## Limitations
 
 - Xfer was not written to be secure. It can be used as part of a secure workflow, if PGP keys are shared beforehand and the data transmitted is encrypted.
-- Xfer does not compress data; repeated data will be encoded as is. 
+- Xfer does not compress data; repeated data will be encoded as is.
 
 ## Future work
 

README.md

@@ -0,0 +1,65 @@
+{
+  description = "xfer - Utility to allow out-of-band sending of arbitrary data";
+
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-25.11";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs =
+    {
+      self,
+      nixpkgs,
+      flake-utils,
+    }:
+    flake-utils.lib.eachDefaultSystem (
+      system:
+      let
+        pkgs = import nixpkgs { inherit system; };
+        python = pkgs.python313;
+        pythonEnv = python.withPackages (ps: [
+          ps.click
+          ps.imageio
+          ps.numpy
+          ps."opencv-python"
+          ps.pillow
+          ps.pyzbar
+          ps.qrcode
+        ]);
+        xfer-package = python.pkgs.buildPythonApplication {
+          pname = "xfer";
+          version = "0.0.5";
+          format = "pyproject";
+          src = self;
+
+          nativeBuildInputs = with python.pkgs; [
+            setuptools
+            wheel
+          ];
+          propagatedBuildInputs = [
+            python.pkgs.click
+            python.pkgs.imageio
+            python.pkgs.numpy
+            python.pkgs."opencv-python"
+            python.pkgs.pillow
+            python.pkgs.pyzbar
+            python.pkgs.qrcode
+          ];
+
+          pythonImportsCheck = [ "xfer" ];
+        };
+
+      in
+      {
+        packages.default = xfer-package;
+        apps.default = flake-utils.lib.mkApp { drv = xfer-package; };
+
+        devShells.default = pkgs.mkShell {
+          packages = [
+            pythonEnv
+            xfer-package
+          ];
+        };
+      }
+    );
+}

flake.lock

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "xfer"
+version = "0.0.5"
+description = "Utility to allow out-of-band sending of arbitrary data"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { file = "LICENSE.md" }
+authors = [{ name = "Chorus One", email = "tech@chorus.one" }]
+classifiers = [
+  "Operating System :: OS Independent",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Natural Language :: English",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Financial and Insurance Industry",
+]
+dependencies = [
+  "click>=8.0",
+  "imageio>=2.9",
+  "numpy>=1.26",
+  "opencv-python>=4.10",
+  "pillow>=10.0",
+  "pyzbar>=0.1.9",
+  "qrcode>=7.4",
+]
+
+[project.urls]
+Homepage = "https://chorus.one"
+
+[project.scripts]
+xfer = "xfer:main"
+
+[dependency-groups]
+dev = []
+
+[tool.setuptools]
+py-modules = ["xfer"]