Installing pyUmbral


Using pip

The easiest way to install pyUmbral is using pip:

$ pip3 install umbral

Build from source code

pyUmbral is maintained on GitHub:

Clone the repository to download the source code.

$ git clone

Once you have acquired the source code, you can…

…embed pyUmbral modules into your own codebase…

from umbral import pre, keys, config

…install pyUmbral with pipenv…

$ pipenv install .

…or install it with python-pip…

$ pip3 install .

Install dependencies

The NuCypher team uses pipenv for managing pyUmbral’s dependencies. The recommended installation procedure is as follows:

$ sudo pip3 install pipenv
$ pipenv install

Post-installation, you can activate the pyUmbral’s virtual environment in your current terminal session by running pipenv shell.

If your installation is successful, the following command will succeed without error.

$ pipenv run python
>>> import umbral

For more information on pipenv, The official documentation is located here:

Development Installation

If you want to participate in developing pyUmbral, you’ll probably want to run the test suite and / or build the documentation, and for that, you must install some additional development requirements.

$ pipenv install --dev --three

To build the documentation locally:

$ pipenv run make html --directory=docs