Make pyscard dependency optional

Nitrokey · Oct 24, 2024 · 260c26b · 260c26b
1 parent e3446a8
commit 260c26b
Show file tree

Hide file tree

Showing 5 changed files with 715 additions and 695 deletions.
diff --git a/docs/packaging.rst b/docs/packaging.rst
@@ -16,3 +16,9 @@ For more information, see the `click documentation`_.
 .. _click documentation: https://click.palletsprojects.com/en/8.1.x/shell-completion/
 
 Unfortunately, man pages for ``nitropy`` are currently not available and cannot be generated automatically.
+
+Optional dependencies
+--------------------
+
+To limit the need to install pyscard, it is made optional.
+If you make it an optional dependency of your package, please patch ``pynitrokey/cli/nk3/pcsc_absent.py`` to indicate users how they can install it.
diff --git a/pynitrokey/cli/nk3/pcsc_absent.py b/pynitrokey/cli/nk3/pcsc_absent.py
@@ -0,0 +1 @@
+PCSC_ABSENT = "pyscard is not available, please consult https://docs.nitrokey.com/nitrokey3/linux/troubleshooting#pcsc-unavailable for more information"