Installation

Using pip

The easiest way of installing Papis is using the PyPI repositories and the pip package manager. Open a terminal and type in

pip install papis

If you are on GNU/Linux-like systems you might need to type sudo to install Papis globally like

sudo pip install papis

If you prefer installing it locally then simply type

pip install --user papis

You can also update Papis with pip

pip install --upgrade papis

Arch Linux

The papis package is found in the Arch Linux AUR repository here. Thanks to Joshua for maintaining this packages!.
If you want to use the git version of papis instead, you can try the papis-git package. Thanks to Julian for maintaining this packages!.

You can install either one with your favorite AUR helper, e.g.

yay -S papis

NixOS

If you are running NixOS or you have the nix package manager installed, you can install Papis by running:

nix-env -i papis

For the development version, just clone the repository

git clone git@github.com:papis/papis.git
cd papis

and start hacking it with

nix-shell --expr 'with import <nixpkgs> {}; papis.overrideDerivation (drv: { src = ./.; })'

This command will provide you a shell with all the dependencies required.

Guix

Note

At this moment there are no recipes for Papis in the main Guix repositories. If such a recipe is added, it is recommended to install from the official sources.

If you are running the Guix System or you have the guix package manager installed and you would like to install papis the ‘Guix way’, you can use the included recipe from python-papis.scm. This recipe can be downloaded locally and installed using

guix package --install-from-file=python-papis.scm

This Guix recipe was made by running the following command

guix import pypi papis@0.13 --recursive

manually fixing some dependencies and switching off some failing tests so that the package could be build with Guix. This can be used for newer versions until an official recipe in the main Guix repositories is published.

From source

To install Papis from source, you can clone the repository using

git clone https://github.com/papis/papis.git

or download the zip file.

Go inside of the papis source folder and you can install it in a standard fashion. For example, using pip

python -m pip install .

If you want to install it locally because you don’t have administrative rights on your computer you can simply type

python -m pip install --user .

Warning

If you install the package locally, the program papis will be installed by default into your ~/.local/bin directory, so that you will have to set your PATH accordingly.

One way of doing this in Bash shells (Linux, Ubuntu on Windows or Cygwin) is by adding the following line to your ~/.bashrc file:

.. code:: sh

export PATH=$PATH:$HOME/.local/bin

Running tests

In order to run the necessary tests to submit a pull request, make sure that the following commands pass

python -m pytest papis/ tests/ --cov=papis
python -m mypy papis
python -m flake8 papis

for it, make sure that you have pytest, flake8 and mypy installed.

You can make sure that you have everything you need to run the tests by doing in the root directory

pip install .[develop]

this command installs the necessary dependencies for developing and running the tests. Look inside of the pyproject.toml file for further information.

You can also look at the folder tools for scripts used in the CI testing phase for further context.