I worked on the project through a virtual environment with virtualenvwrapper
and I highly recommend to do so as well. However, whether or not you are in a
virtual environment, the installation proceeds as follows:
-
To download and install the source code of the project:
$ cd <directory you want to install to> $ git clone https://github.com/QDucasse/sneaky $ python setup.py install
-
To download and install the source code of the project in a new virtual environment:
Download of the source code & Creation of the virtual environment
$ cd <directory you want to install to> $ git clone https://github.com/QDucasse/sneaky $ cd sneaky $ mkvirtualenv -a . -r requirements.txt VIRTUALENV_NAME
Launch of the environment & installation of the project
$ workon VIRTUALENV_NAME $ pip install -e .
Quick presentation of the different modules of the project:
- Package1: Dynamic systems models.
This project uses the following external libraries:
If installed as specified above, the requirements are stated in the requirements.txt
file
and therefore automatically installed.
However, you can install each of them separately with the command:
$ pip install <library>
- Basic project structure
All tests are written to work with nose
and/or pytest
. Just type pytest
or
nosetests
as a command line in the project. Every test file can still be launched
by executing the testfile itself.
$ python sneaky/tests/chosentest.py
$ pytest