pickups Documentation, Release 0.7.0
• Create a virtual environment (using virtualenvwrapper):
$ mkvirtualenv pickups
• Switch to the newly created environment:
$ workon pickups
• Install a development version of pickups to run isolated tests:
$ pip install -e /PATH/TO/PICKUPS
• Pickups is using tox to run tests on multiple environments (p2.7, p3.4, ...). Installing tox:
$ pip install tox
• Verify everything is well by invoking:
$ tox
which will create virtual environments for py2.7 and py3.4, run tests and create docs. You can revisit the created
environments in tox.ini. These steps should be enough to start developing using tox to run all build steps. If you
however want to run isolated tests, keep on reading.
I am happy to integrate pull-requests. So please start developing by forking the project on Github and then work on
your copy of the project. You can merge your contribution by creating a pull-request.
Optional Setup
• Install dependencies needed to run tests directly:
# Pytest as testrunner
$ pip install pytest
$
# pytest coverage plugin
$ pip install pytest-cov
$
# Mock objects module (needed when using python < 3)
$ pip install mock
3.3.2 GIT
We use GIT to manage pickups’ source code. The code is hosted at Github. You can get the code by cloning the
repository:
# https
$ git clone https://github.com/maiksensi/pickups.git
3.3.3 Testing
Tox is used in combination with the amazing pytest package. So invoking a simple:
$ tox
will test all predefined environments for you. If you want to restrict tox to a single environment you can use:
3.3. Developer Documentation 9
Commentaires sur ces manuels