diff --git a/README.md b/README.md index 974c2b6..73e0758 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,12 @@ Plugin that tells [tox](https://tox.readthedocs.org/en/latest/) to use [`pyenv which`](https://github.com/yyuu/pyenv/blob/master/COMMANDS.md#pyenv-which) to [find python executables](https://testrun.org/tox/latest/plugins.html#tox.hookspecs.tox_get_python_executable) -#### Your project's [circle.yml](https://circleci.com/docs/configuration) +### Why does this exist? + +See the full story here https://github.com/samstav/circleci-python-sandbox/issues/1 + + +### Your project's [circle.yml](https://circleci.com/docs/configuration) In order for `tox` to have the versions of python you want available, set them using [`pyenv local`](https://github.com/yyuu/pyenv/blob/master/COMMANDS.md#pyenv-local) @@ -17,7 +22,7 @@ dependencies: The versions passed to `pyenv local` must be [installed](https://github.com/yyuu/pyenv/blob/master/COMMANDS.md#pyenv-install) for this to work. See [CircleCI Preinstalled Python Versions](#circleci-preinstalled-python-versions) for a list. -#### Corresponding [tox.ini](https://tox.readthedocs.org/en/latest/config.html) +### Corresponding [tox.ini](https://tox.readthedocs.org/en/latest/config.html) ```ini [tox] @@ -26,11 +31,11 @@ envlist = py27,py34,py35 The result of the setup above means running `tox` will run tests against python 2.7.9, python 3.4.3 and python 3.5.0, assuming those versions of python have been [`pyenv install`ed](https://github.com/yyuu/pyenv/blob/master/COMMANDS.md#pyenv-install) -#### notes +### Notes If you want tox to _exclusively_ use `pyenv which` to find executables, you will need use the `--tox-pyenv-no-fallback` command line option, or set `tox_pyenv_fallback=False` in your tox.ini. By default, if `tox-pyenv` fails to find a python executable it will fallback to tox's built-in strategy. -#### CircleCI Preinstalled Python Versions +### CircleCI Preinstalled Python Versions Here is the list of python versions that are *pre-installed* in the CircleCI build environment (as of 09/27/2017): @@ -75,4 +80,3 @@ dependencies: - pyenv install --skip-existing 3.6-dev - pyenv local 3.6-dev ``` -