Evie Litherland-Smith 0396bdb66a Move nix shell to separate shell.nix

Update README for nix shell instructions, refile long lines

2024-05-27 08:34:36 +01:00

Nix Background Upgrade

Upgrade NixOS system (and/or home-manager) in the background, with notification support.

Early stages of development, subject to change and likely not working at the current stage.

Install

Clone the repository and install with pip (or preferred Python packaging system):

git clone https://git.xenia.me.uk/pixelifytica/nix-background-upgrade.git
python3 -m pip install ./nix-background-upgrade

Project uses Poetry to manage dependencies.

Install Poetry (see documentation for more details), for example using pipx:

pipx install poetry

Then install project using poetry:

poetry install

Python code is formatted using black and isort.

pre-commit is used to ensure formatting of new/changed files. Install pre-commit hooks with:

pre-commit install --install-hooks

Project provides a Nix flake.nix and shell.nix to get up and running quickly.

Run nix develop (Flake) or nix-shell (non-Flake) to enter development shell containing project dependencies.