Compare commits

...

2 commits

Author SHA1 Message Date
Evie Litherland-Smith 6772fdbc2c Check for nixos-rebuild command triggers notification if not found
Add source argument to default notification title
2024-05-27 08:36:42 +01:00
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
5 changed files with 64 additions and 27 deletions

View file

@ -1,10 +1,13 @@
# Nix Background Upgrade # Nix Background Upgrade
Upgrade NixOS system (and/or home-manager) in the background, with notification support. 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.** **Early stages of development, subject to change and likely not
working at the current stage.**
## Install ## Install
Clone the repository and install with pip (or preferred Python packaging system): Clone the repository and install with pip (or preferred Python
packaging system):
```bash ```bash
git clone https://git.xenia.me.uk/pixelifytica/nix-background-upgrade.git git clone https://git.xenia.me.uk/pixelifytica/nix-background-upgrade.git
@ -12,9 +15,12 @@ python3 -m pip install ./nix-background-upgrade
``` ```
### For development ### For development
Project uses [Poetry](https://python-poetry.org/ "Poetry: Python packaging and dependency management tool") to manage dependencies. Project uses [Poetry](https://python-poetry.org/ "Poetry: Python
packaging and dependency management tool") to manage dependencies.
Install Poetry (see [documentation](https://python-poetry.org/docs/#installation) for more details), for example using `pipx`: Install Poetry (see
[documentation](https://python-poetry.org/docs/#installation) for more
details), for example using `pipx`:
```bash ```bash
pipx install poetry pipx install poetry
@ -26,14 +32,23 @@ Then install project using `poetry`:
poetry install poetry install
``` ```
Python code is formatted using [black](https://pypi.org/project/black/ "The uncompromising code formatter") and [isort](https://pypi.org/project/isort/ "A Python utility / library to sort Python imports"). Python code is formatted using [black](https://pypi.org/project/black/
"The uncompromising code formatter") and
[isort](https://pypi.org/project/isort/ "A Python utility / library to
sort Python imports").
#### `pre-commit` #### `pre-commit`
[pre-commit](https://pre-commit.com/ "A framework for managing and maintaining multi-language pre-commit hooks") is used to ensure formatting of new/changed files. Install pre-commit hooks with: [pre-commit](https://pre-commit.com/ "A framework for managing and
maintaining multi-language pre-commit hooks") is used to ensure
formatting of new/changed files. Install pre-commit hooks with:
```bash ```bash
pre-commit install --install-hooks pre-commit install --install-hooks
``` ```
### Nix Flake ### Nix Flake
Project provides a Nix `flake.nix` to get up and running quickly. 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.

View file

@ -29,18 +29,10 @@
}; };
}); });
devShells = forAllSystems (system: let devShells = forAllSystems (system: {
default = import ./shell.nix {
pkgs = pkgs.${system};
inherit (poetry2nix.lib.mkPoetry2Nix {pkgs = pkgs.${system};}) mkPoetryEnv; inherit (poetry2nix.lib.mkPoetry2Nix {pkgs = pkgs.${system};}) mkPoetryEnv;
in {
default = pkgs.${system}.mkShellNoCC {
packages = with pkgs.${system}; [
(mkPoetryEnv {
projectDir = self;
preferWheels = true;
extraPackages = ps: with ps; [python-lsp-server];
})
poetry
];
}; };
}); });
}; };

15
shell.nix Normal file
View file

@ -0,0 +1,15 @@
{
pkgs ? import <nixpkgs> {},
mkPoetryEnv ? ((builtins.getFlake "github:nix-community/poetry2nix").lib.mkPoetry2Nix {inherit pkgs;}).mkPoetryEnv,
}:
pkgs.mkShellNoCC {
packages = with pkgs; [
(mkPoetryEnv {
projectDir = ./.;
preferWheels = true;
editablePackageSources = {nix_background_upgrade = ./src;};
extraPackages = ps: with ps; [python-lsp-server];
})
poetry
];
}

View file

@ -3,13 +3,23 @@ Control upgrading NixOS configuration
""" """
import subprocess import subprocess
from os import getenv
from .notification import create_notification
NIXOS_CONFIGURATION: str = getenv("NIXOS_CONFIGURATION", "")
def nixos_switch() -> None: def nixos_switch() -> int:
""" """
Switch NixOS system to new version Switch NixOS system to new version
:returns: None :returns: Error code of `sudo nixos-rebuild switch` call
""" """
subprocess.Popen("which -a nixos-rebuild".split()) notification = create_notification(source="nixos_switch")
return try:
subprocess.run("which -a nixos-rebuild".split()).check_returncode()
except subprocess.CalledProcessError as e:
notification.message = e
notification.send()
return 0

View file

@ -1,16 +1,21 @@
from pathlib import Path from pathlib import Path
from typing import Optional
from notifypy import Notify from notifypy import Notify
def create_notification() -> Notify: def create_notification(source: Optional[str] = None) -> Notify:
""" """
Create notification class Create notification class
:param source: Name of originating file or function, used in default notification
title
:returns: Notify class with custom defaults :returns: Notify class with custom defaults
""" """
if source is None:
source = "Nix process"
return Notify( return Notify(
default_notification_title="Nix Background Update", default_notification_title="Message from {}".format(source),
default_notification_message="Message from Nix process",
default_notification_icon=Path(__file__).parent / "./nix-snowflake.png", default_notification_icon=Path(__file__).parent / "./nix-snowflake.png",
) )