Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add packaging info #459

Merged
merged 1 commit into from
Oct 30, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/packaging.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Packaging pynitrokey
====================

When ``pynitrokey`` is packaged for a distribution or a package manager, we recommend that the package provides both the ``pynitrokey`` Python library and the ``nitropy`` executable.
Alternatively, the Python library can be packaged as ``pynitrokey`` and the executable as ``nitropy``.
(Note that we consider splitting ``pynitrokey`` into a library and an executable in a future release.)

Shell completions for Bash, Zsh and Fish can be generated from the ``nitropy`` script::

$ _NITROPY_COMPLETE=bash_source nitropy > nitropy.bash
$ _NITROPY_COMPLETE=zsh_source nitropy > nitropy.zsh
$ _NITROPY_COMPLETE=fish_source nitropy > nitropy.fish

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.