From 6f9a388d2346e3837479536c9e14632ff9fa0961 Mon Sep 17 00:00:00 2001 From: Daniel Langbein Date: Thu, 28 Sep 2023 17:12:10 +0200 Subject: [PATCH] add shell.nix and update README --- .gitignore | 1 + README.md | 16 ++++++++++++++-- shell.nix | 13 +++++++++++++ 3 files changed, 28 insertions(+), 2 deletions(-) create mode 100644 shell.nix diff --git a/.gitignore b/.gitignore index 19b78e9..bbde56a 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ /venv/ /build/ **/*.egg-info/ +/dist/ # makepkg /packaging/netcup-dns/ diff --git a/README.md b/README.md index 405e25d..5e1bc89 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,25 @@ Update DNS A/AAAA records with your current external IP address using the netcup ## Installation -On Arch Linux: +Install release from PyPI (https://pypi.org/project/netcup-dns/): + +```shell +pip install netcup-dns +``` + +Install release from TestPyPI (https://test.pypi.org/project/netcup-dns/): + +```shell +pip install -i https://test.pypi.org/simple/ netcup-dns +``` + +Build and install on Arch Linux: ```shell make ``` -With `pip`: +Build and install with `pip`: ```shell make install-pip diff --git a/shell.nix b/shell.nix new file mode 100644 index 0000000..6f8a7d6 --- /dev/null +++ b/shell.nix @@ -0,0 +1,13 @@ +# https://nixos.wiki/wiki/Python#Development_shell +{ pkgs ? import {} }: +let + my-python-packages = ps: with ps; [ + requests + nc-dnsapi + + # Build dependencies only. + build + twine + ]; + my-python = pkgs.python3.withPackages my-python-packages; +in my-python.env