pyenv and tox combined with the power of docker.
boxer is a an automation tool that manages testing and python environments. The power of boxer lies in its ability to run tests against your code, with all versions of python, in complete isolation from your local devlopment environment. This is helpful because you no longer have to think about installing python, let alone multiple versions of it. Simply run boxer in your command line and you have the power of tox, pyenv, and docker at your fingertips.
- Automatically manages your python environments
- Runs tests in an isolated conatainer, away from your local environment
- Use tox as you always have
- Python versions 2.7.13, 3.5.3, 3.6.0 are included by default
- Use any python >= 2.7
boxer is not yet ready to be integrated with CI.
Under the hood, boxer is using docker-py, some existing images that I created on the Docker Hub, and the awesome click package. As you run the cli, a Dockerfile is created dynamically in the .boxer directory chained with a few images that I created for this project. boxer then builds the images created in the .boxer directory, runs them, and executes tox against your tox.ini.
Images on the Docker Hub:
- docker
- pip
- connection to docker hub
# $ pip install boxer # soon
$ pip install git+https://github.com/bradleygolden/boxer.git
$ cd <project/with/tox.ini>
$ boxer
Alternatively, you can include more versions of python youself.
$ boxer -p 3.5.1 -p 3.4.4
Step 1/1 : FROM bgolden/docker-tox:latest
# Executing 3 build triggers...
Step 1/1 : COPY $BUILD_PATH /workspace
Step 1/1 : WORKDIR /workspace
Step 1/1 : CMD tox
---> Running in 7884d8ae4472
---> 0fef0fa44d49
Successfully built 0fef0fa44d49
GLOB sdist-make: /workspace/setup.py
py36 create: /workspace/.tox/py36
py36 installdeps: pytest
py36 inst: /workspace/.tox/dist/Example App-1.0.zip
py36 installed: appdirs==1.4.3,Example-App==1.0,packaging==16.8,py==1.4.32,pyparsing==2.2.0,pytest==3.0.6,six==1.10.0
py36 runtests: PYTHONHASHSEED='4201167492'
py36 runtests: commands[0] | pytest
============================= test session starts ==============================
platform linux -- Python 3.6.0, pytest-3.0.6, py-1.4.32, pluggy-0.4.0
rootdir: /workspace, inifile:
collected 1 items
test_app.py .
=========================== 1 passed in 0.01 seconds ===========================
___________________________________ summary ____________________________________
py36: commands succeeded
congratulations :)
$ boxer --help
Usage: boxer [OPTIONS]
Example script.
Options:
--project TEXT Directory where your tox project is located
--image TEXT Tox docker image you wish to use to run with boxer
--logs TEXT Path to boxer log file
--boxer TEXT Path to store boxer data
--dockerfile TEXT Path to dockerfile
--dockerignore TEXT Path to dockerignore file
--tag TEXT Name of container tag saved by boxer
--tox-file TEXT Path to tox file
-p, --python TEXT Additional python versions to use (e.g. 2.7.13)
--help Show this message and exit.