Tox introduction

1. @signalpillar (2015)
TOX - virtualenv automation tool

2. Where we all start

3. ● virtualenv .env
● source .env/bin/activate
● pip install -r requirements.txt
● py.test
Where we all start

4. ● virtualenv(wrapper) + pip + bash|Makefile|Fabfile
● Optionally `setup.py`
Where we all start

5. Where we all start (Makefile)

6. ● Easy way to start from 0 for a newcomer
● Manage dependencies
● Coordination with other developers
● Consistent build procedure between projects
● Good integration with CI
Goals

7. More Happiness Units

8. $ tox -h
usage: tox [-h] [--version] [-v] [--showconfig] [-l] [-c
CONFIGFILE]
[-e envlist] [--notest] [--sdistonly] [--
installpkg PATH]
[--develop] [--set-home] [-i URL] [--pre] [-r] [--
result-json PATH]
[--hashseed SEED] [--force-dep REQ] [--
sitepackages]
[--skip-missing-interpreters]
[args [args ...]]
Tox

9. ● Cross-Python: Cpython 2.6-3.x, Jython, pypy
py2[4567] py3[01234] jython pypy pypy3
● Cross-platform: Windows, Unit style envs
● Driven by ini file
● Continuous server integration
● Good documentation/examples
Tox

10. ● pip install tox
● configure via tox.ini file in the root of a project
● tox
● Profit!
Tox success story

11. Tox
project/ {toxinidir}, {setupdir}, {changedir}
- .tox/ {toxworkdir}
- tox.ini
- setup.py
# different in Jenkins context
{homedir}/.tox/distshare {distshare}

12. Tox.ini

13. ● create env
○ setup.py sdist ( if not skipsdist=True )
● install deps
○ install generated sdist ( if not skipsdist=True )
● pip install -e . ( if usedevelop = True )
● run commands
● deactivate env
Tox flow

14. Demo based on
https://github.com/signalpillar/fp-2015-march
Tox - Demo

15. Tox.ini - Substitutions
● Global/Local (env specific)
● Environment variables {env:KEY[:DEFAULT]}
● Commands positional args {posargs:DEFAULTS}
● Values from other sections {[sectionname]
valuename}

16. Tox.ini - global substitution variables
● toxinidir
● toxworkdir
● homedir
● distdir
● distshare

17. Tox.ini - env-specific substitution variables
● envname
● envpython
● envdir
● envbindir
● envsitepackagesdir
● envtmpdir
● envlogdir

18. [testenv]
deps=
-rrequirements.txt
{[base]deps}
nose==1.1.2
coverage>=3.5.1
commands=nosetests
Tox - Dependencies

19. Demo based on
https://github.com/signalpillar/tox-subprojects-demo
Tox - Demo

20. Tox just manages venvs

21. Search filename:tox.ini on GitHub
Find Tox.ini examles

22. ● https://www.facebook.com/groups/odesa.python/
● http://www.meetup.com/Odesa-Python-Meetup/
Odessa Python User Group

23. Thank You!