When you are developing packages for Python you need some way to test whether your package works on someone else's computer. Tox is a great tool for this, but doesn't work well with Anaconda. With some basic steps however you can have your code tested on tox without much trouble.
In this post I will show you how to configure Anaconda correctly for use with Tox on Windows 10.
What is tox?
Tox is a tool that makes it possible to execute tests in an isolated environment. Running python tests in an isolated environment useful for a number of reasons:
- Different versions of python have different requirements, if you want your package to work for a specific version you have to test it with that version.
- Your development environment has packages installed, which you may have forgotten to include as a dependency in your package. When someone tries to use your package he/she may run into problems because he/she is missing packages.
- You may require some additional preparation in the form of scripts before you can execute tests against your package. Doing this manually is hard to get right.
Tox makes these three things easy, so I like to use it for testing Python code whenever I can.
Why would you use Anaconda?
Okay, so Tox is a useful tool if you worry about quality. But what about Anaconda? There's an official Python release which works great, so why bother using something else?
Anaconda is a specialized version of Python optimized for statistics and data science. It contains special versions of certain packages that aren't easily obtained for the official Python release. This is especially true on Windows.
Keras for example uses the scipy package that is not available on Windows through pip. Instead you need to get a proper version from some university website. It works, but it is a pain in the behind to get working on Windows.
Installing Anaconda is easy, you can have it up and running in minutes without having to manually download all sorts of packages.
That's the reason why I recently moved over to Anaconda. There are downsides to Anaconda as well as you can see from this post, but I think the advantages make up for that.
Step 1: Install anaconda
So given that you want Anaconda, because you're doing Data science and you want to build quality packages, let's get started by installing Anaconda. If you haven't done so of course.
You can install Anaconda from their website. Make sure that you add the anaconda binaries to your
PATH variable. This is an option that you can select in their installer while you're running the installation.
Step 2: Install the basic packages
With Anaconda installed you need to install a few additional packages:
conda install virtualenv
pip install tox
You need to install
conda, since the other version that comes from pypi.org doesn't work properly within Anaconda.
Step 3: Setup the test environments for tox
The third step in the configuration process is to setup the right python environments for tox to use. This step depends on what versions of python you want to use with Tox.
Tox allows you to specify which versions of python your code should be tested against. You can specify this in a
tox.ini file in the root of your project. The file looks like this:
python -c 'import nltk; nltk.download("punkt")'
tox section specifies overall options for the tests. Here you specify the python versions you want to test against. Each python version is prefixed with the letter py and the major and minor version number.
testenv section specifies how to control the test environment (in the versions of python you specified in the
tox section). For example, you can specify additional dependencies that should be installed in the environment.
Also in the
testenv section you will find the commands option. This option specifies which test commands should be run. For example, I need the nltk module to be installed and updated. Afterwards I want the unit-tests to be executed using
If you specify py35 and py27 in tox you will need to make sure that these versions can be discovered by the tox runtime. On Linux you don't need to do anything special. On Windows however you need to setup the python versions manually.
To install the right python versions for tox you need to execute the following command in powershell/cmd:
conda create -p C:\Python35 python=3.5
The path parameter points to
C:\\Python35 which is a well-known location that tox resolves automatically. The parameter
python=3.5 tells Anaconda to create a Python 3.5 environment.
If you want a different version you need to change the version number in both the path and the python parameter of the
conda create command.
So if you want python 2.7 you execute:
conda create -p C:\Python27 python=2.7
Step 4: Execute tests
Now that you have all necessary environments for tox you can navigate to the root of your project and execute
tox to run the tests.
When you run
tox it will package your code using the
setuptools package and execute the following steps for each python environment:
- Create a new environment for the python version
- Install the package in the test environment
- Install the additional dependencies in the test environment
- Execute the test commands specified in the
The results are collected in the terminal.
Step 5: Happy testing
Tox is a really useful tool for testing code. The test environments are isolated so that you simulate installation of your code on a clean machine. That way you know for sure that your package works on someone else's machine.
Also, because you have separate environments you can check that your package works on different versions of Python. Another problem that many Python developers hit.
Finally, tox makes it easy to script any setup steps that you need to perform before executing tests. This eliminates human error.