nucypher

History

Kieran R. Prasch c0e85029d4 Delay node discovery startup		2021-01-12 13:10:15 -08:00
..
scripts	update scripts	2019-03-28 16:06:16 -07:00
8-federated-ursulas.yml	Delay node discovery startup	2021-01-12 13:10:15 -08:00
Dockerfile	Install patch in docker	2021-01-05 16:21:08 -08:00
README.md	update docker image version and readme	2019-06-06 12:17:41 -07:00
docker-compose.yml	use ipdb as debugger in nucypher-dev docker container	2020-02-04 09:12:09 -08:00

README.md

Developing with Docker

The intention of the Docker configurations in this directory is to enable anyone to develop and test NuCypher on all major operating systems with minimal prerequisites and installation hassle.

quickstart

install Docker
install Docker Compose
cd to dev/docker (where this README is located)
docker-compose up --build this must be done once to complete install

Then you can do things like:

run the tests: docker-compose run nucypher-dev pytest
start up an ursula: docker-compose run nucypher-dev nucypher ursula run --dev --federated-only
open a shell: docker-compose run nucypher-dev bash
try some of the scripts in dev/docker/scripts/

*tested on (Ubuntu 16, MacOS 10.14, Windows 10)

From there you can develop, modify code, test as normal.

other cases

run a network of 8 independent Ursulas docker-compose -f 8-federated-ursulas.yml up
get the local ports these ursulas will be exposed on docker ps
to stop them... docker-compose -f 8-federated-ursulas.yml stop

Pycharm (pro version only)

You can configure pycharm to use the python interpreter inside docker.
docs for this are here