Setting up L2t scaffolder in a virtualenv¶

For development purposes, l2t_scaffolder can be installed using virtualenv (preferred method).

Fedora Core¶

To install virtualenv on Fedora Core (or equivalent) run:

$ sudo dnf install python3-virtualenv

TODO add more text

To install virtualenv on Ubuntu (or equivalent) run:

$ sudo apt-get install python-virtualenv python3-virtualenv

TODO add more text

$ sudo apt-get install libyaml-dev liblzma-dev

To create a virtualenv:

virtualenv -p PATH_TO_PYTHON3 scaffolderoenv

eg:

$ virtualenv -p /usr/bin/python3 scaffolderoenv

To activate the virtualenv:

$ source ./scaffolderenv/bin/activate

Note that using pip outside virtualenv is not recommended since it ignores your systems package manager.

Make sure that pip is up-to-date:

$ pip3 install --upgrade pip

To deactivate the virtualenv run:

$ deactivate

Before submitting code to the project, make sure that you have created a fork of the l2tscaffolder project, and check out your personal fork:

$ git clone https://github.com/USERNAME/l2tscaffolder.git

Add the upstream repo:

$ git remote add upstream https://github.com/log2timeline/l2tscaffolder.git

And then you can create a feature branch to work on.

$ git checkout -b my_feature