Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
pyproject: remove unneeded data-files and add a PACKAGING.md file
- Loading branch information
Showing
2 changed files
with
56 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
Guidelines for Packaging | ||
======================== | ||
|
||
These are some loose notes about packing Papis meant to highlight the different | ||
components that are available and not to require a particular format. | ||
|
||
Dependencies | ||
============ | ||
|
||
See `pyproject.toml` for a complete list of dependencies and minimum versions. | ||
|
||
Wheels | ||
====== | ||
|
||
Papis uses the standard `pyproject.toml`-based format using `setuptools` as a | ||
build backend. Wheels can be generated using | ||
``` | ||
python -m build --wheel --skip-dependency-check . | ||
``` | ||
|
||
A source distribution (*sdist*) can be build together with the wheel using just | ||
``` | ||
python -m build --skip-dependency-check . | ||
``` | ||
|
||
Man pages | ||
========= | ||
|
||
Papis documentation uses Sphinx, which can also generate man pages. By default, | ||
we create man pages for all the standard Papis commands and some general | ||
documentation for the configuration file. These can be generated using | ||
``` | ||
make -C doc man | ||
``` | ||
|
||
The resulting man pages can then be found in `doc/build/man` and should be installed | ||
in appropriate locations. | ||
|
||
Shell completions | ||
================= | ||
|
||
Papis uses `click` for its command-line parsing. To generate completions, use | ||
``` | ||
_PAPIS_COMPLETE=bash_source papis | ||
_PAPIS_COMPLETE=fish_source papis | ||
_PAPIS_COMPLETE=zsh_source papis | ||
``` | ||
|
||
Note that the generated completion files are not static and can pick up any | ||
custom Papis commands and plugins even after installation. | ||
|
||
Desktop file | ||
============ | ||
|
||
There is a desktop file in `contrib/papis.desktop`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters