Installation

Dependencies / Pre-Installs

Install / Setup NFD. This documentation assumes basic use of NFD.

Instruction for use

Install the latest release with pip:

$ /usr/bin/pip3 install ndn-svs

Optionally, you can install the latest development version from source: (note: also add root folder of this github repo to PYTHONPATH environment variable)

$ git clone https://github.com/justincpresley/ndn-python-svs.git
$ cd ndn-python-svs && /usr/bin/pip3 install -e .

Instruction for developers

Setup virtual environment with editable installation:

$ python3 -m venv venv
$ . venv/bin/activate
$ pip3 install -e .

Run all tests:

$ pip3 install pytest
$ pytest

Compile the documentation with Sphinx:

$ cd docs && pip3 install -r requirements.txt
$ make html
$ open _build/html/index.html