nucypher can be run either from a docker container or via local installation. Running
via a docker container simplifies the installation process and negates the need for a local installation.
Docker Installation and Update¶
Optional Depending on the setup you want, post install instructions, additional docker configuration is available here.
Get the latest nucypher image:
docker pull nucypher/nucypher:latest
nucypher supports Python 3.7 and 3.8. If you don’t already have it, install Python.
In order to isolate global system dependencies from nucypher-specific dependencies, we highly recommend
python-virtualenv to install
nucypher inside a dedicated virtual environment.
For full documentation on virtualenv see: https://virtualenv.pypa.io/en/latest/:
Create a Virtual Environment
Create a virtual environment in a folder somewhere on your machine.This virtual environment is a self-contained directory tree that will contain a python installation for a particular version of Python, and various installed packages needed to run the node.
$ python -m venv /your/path/nucypher-venv ...
Activate the newly created virtual environment:
$ source /your/path/nucypher-venv/bin/activate ... (nucypher-venv)$
A successfully activated virtual environment is indicated by
(nucypher-venv)$prepended to your console’s prompt
From now on, if you need to execute any
nucyphercommands you should do so within the activated virtual environment.
(nucypher-venv)$ pip3 install -U nucypher
Before continuing, verify that your
nucypherinstallation and entry points are functional.
Activate your virtual environment, if not activated already:
$ source /your/path/nucypher-venv/bin/activate
nucypheris importable. No response is successful, silence is golden:
(nucypher-venv)$ python -c "import nucypher"
Then, run the
(nucypher-venv)$ nucypher --help ...
If successful you will see a list of possible usage options (
--logging-path, etc.) and commands (