GSLab Python Library Collection 4.1.3
This repository contains the following GSLab Python libraries:
Information about each of these packages is available in its internal documentation.
- Python 2.7
mock(> 2.0.0) and
coveragein order to run the unit tests
The preferred installation method is to use pip:
pip install git+ssh://email@example.com/gslab-econ/gslab_python.git@master
pip install git+https://firstname.lastname@example.org/gslab-econ/gslab_python.git@master
which are the SSH and HTTPS protocol versions.
The package at any tagged release, branch, or commit can be installed with the same commands, just changing
master to the desirved target e.g.,
pip install git+ssh://email@example.com/gslab-econ/gslab_python.git@<tagg, branch name, or commit hash>
Note that this installation procedure may require obtaining machine privileges through,
Alternatively, one may install the local version of gslab_python by running (from the root of the repository)
pip install .
We do not reccommend that these packages be installed by executing
python setup.py install
This method of installation uses egg files rather than Wheels, which can cause conflicts with previous versions of
gslab_tools. If this method of installation is executed, some files need to be removed from the directory with a
GSLab_Tools.egg-info, which are built upon installation. This argument can be called by executing
python setup.py clean
We recommend that users use coverage
to run this repository's unit tests. Upon installing coverage (this can be done with
pip using the command
pip install coverage), one may test
and then produce a code coverage report the commands:
python setup.py test [--include=<paths>]
Here, the optional
--include= argument specifies the files whose test results
should be included in the coverage report produced by the command.
It works as
coverage's argument of the same name does. The command should be
run without this option before committing to
Q: What if I want to install a different branch called
gslab_python rather than
git checkout dev that branch of the repo before installing, or change
@dev in the
pip install instruction.