Welcome to Tox Matrix’s documentation!¶
Contents:
Tox Matrix¶
Project for creating tox.ini files with multiple dependencies.
WARNING! As of version 1.8.0 of tox it is possible to create generative envlist declarations.
Described in tox documentation. That feature of tox practically makes this project obsolete.
- Free software: BSD license
- Documentation: http://tox-matrix.rtfd.org.
A little utility script to generate tox.ini files.
It should be handy in case where your project have multiple different dependencies
with different version and you would like to test all available configurations of them.
Quick start¶
Install it:
pip install tox-matrix
Now let’s assume you’d like to test your project against different versions
of Django (latest 1.5.X and 1.6.X ) and Fabric (latest 1.7.X and 1.8.X)
using python2.7 and python3.3.
You could do something like this:
tox-matrix generate -d Django -v 1.5,1.6,1.7 -d Fabric -v 1.7,1.8,1.9 -p 2.7 -p 3.3
Which should generate this tox.ini file content to stdout:
[tox]
envlist = py27-A, py27-B, py27-C, py27-D, py33-A, py33-B, py33-C, py33-D
[testenv]
commands = py.test
[testenv:py27-A]
basepython = python2.7
deps = {[testenv]deps}
Django>=1.5,<1.6
Fabric>=1.7,<1.8
[testenv:py27-B]
basepython = python2.7
deps = {[testenv]deps}
Django>=1.5,<1.6
Fabric>=1.8,<1.9
[testenv:py27-C]
basepython = python2.7
deps = {[testenv]deps}
Django>=1.6,<1.7
Fabric>=1.7,<1.8
[testenv:py27-D]
basepython = python2.7
deps = {[testenv]deps}
Django>=1.6,<1.7
Fabric>=1.8,<1.9
[testenv:py33-A]
basepython = python3.3
deps = {[testenv]deps}
Django>=1.5,<1.6
Fabric>=1.7,<1.8
[testenv:py33-B]
basepython = python3.3
deps = {[testenv]deps}
Django>=1.5,<1.6
Fabric>=1.8,<1.9
[testenv:py33-C]
basepython = python3.3
deps = {[testenv]deps}
Django>=1.6,<1.7
Fabric>=1.7,<1.8
[testenv:py33-D]
basepython = python3.3
deps = {[testenv]deps}
Django>=1.6,<1.7
Fabric>=1.8,<1.9
Features¶
- Generate tox.ini files
- Pin versions either with exact ones or by range
- Use a Jinja2 template for your tox.ini file
Installation¶
At the command line:
$ easy_install tox-matrix
Or, if you have virtualenvwrapper installed:
$ mkvirtualenv tox-matrix
$ pip install tox-matrix
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/slafs/tox-matrix/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
Write Documentation¶
Tox Matrix could always use more documentation, whether as part of the official Tox Matrix docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/slafs/tox-matrix/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up tox-matrix for local development.
Fork the tox-matrix repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/tox-matrix.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv tox-matrix $ cd tox-matrix/ $ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 tox-matrix tests $ python setup.py test $ tox
To get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
- The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/slafs/tox-matrix/pull_requests and make sure that the tests pass for all supported Python versions.
Credits¶
Development Lead¶
- Slawek Ehlert <slafs@op.pl>
Contributors¶
None yet. Why not be the first?