Installation of the Development Environment
It is highly recommended to set up a virtual environment for JetConf development. The following procedure uses the venv module for this purpose (it is included in the standard Python library since version 3.3).
Install the latest stable Python 3 version.
Clone the JetConf project in a directory of your choice:
$ git clone email@example.com:labs/jetconf.git
Create the virtual environment:
$ pyvenv jetconf
Activate the virtual environment:
$ cd jetconf $ source bin/activate
Install required standard packages inside the virtual environment:
$ make install-deps
Install recent development revision of Yangson library:
$ make yangson
When inside the virtual environment, the shell prompt should change to something like
To leave the virtual environment, just do
The virtual environment can be entered anytime later by executing step 4. The other steps need to be performed just once.
The setup described above has a few consequences that have to be kept in mind:
- Any project files that need to go to
bin(executable Python scripts),
libhave to be added as exceptions to
.gitignore, for example
- After adding a new Python module dependency, it is necessary to run
$ pip freeze > requirements.txt