Make pyscard dependency optional #580
Conversation
|
Not sure how to verify that pyscard is still included in the pre-built binaries. |
|
Looks like flit by default installs all dependencies so we should be good: https://flit.pypa.io/en/stable/cmdline.html#cmdoption-flit-install-deps |
pynitrokey/cli/nk3/piv.py
Outdated
| @click.argument("args", nargs=-1, type=click.UNPROCESSED) | ||
| def piv(args: list[str]) -> None: | ||
| """Nitrokey PIV App""" | ||
| local_critical(PCSC_ABSENT) |
There was a problem hiding this comment.
I would set support_hint=False because this is not an unexpected error (so we don’t need the logs) and it is easy to miss the actual error message in all that noise.
| 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. |
There was a problem hiding this comment.
Should we recommend to always enable it if possible?
There was a problem hiding this comment.
I'm in favor of allowing users to make use of a minimal set of dependencies.
pynitrokey/cli/nk3/pcsc_absent.py
Outdated
| @@ -0,0 +1 @@ | |||
| PCSC_ABSENT = "pyscard is not available, please consult https://docs.nitrokey.com/nitrokey3/linux/troubleshooting#pcsc-unavailable for more information" | |||
There was a problem hiding this comment.
| PCSC_ABSENT = "pyscard is not available, please consult https://docs.nitrokey.com/nitrokey3/linux/troubleshooting#pcsc-unavailable for more information" | |
| PCSC_ABSENT = "This command requires the pyscard library that is not available on your system. Please consult https://docs.nitrokey.com/nitrokey3/linux/troubleshooting#pcsc-unavailable for more information" |
|
AFAIR it is easy to build the installer locally. I can test it later today or tomorrow to verify the behavior. |
|
The Linux onefile build includes pcsc so the Windows builds should be fine too. |
|
This PR allows using nitropy without pyscard installed.
Changes
Checklist
Make sure to run
make checkandmake fixbefore creating a PR, otherwise the CI will fail.Test Environment and Execution
Relevant Output Example
Fixes #579