Skip to content
This repository has been archived by the owner on Jul 14, 2023. It is now read-only.

Commit

Permalink
update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
stavxyz committed Aug 29, 2017
1 parent 3f160c9 commit 09bc593
Showing 1 changed file with 54 additions and 7 deletions.
61 changes: 54 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ 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>`__
#########################################################################
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In order for ``tox`` to have the versions of python you want available,
set them using
Expand All @@ -24,12 +24,11 @@ set them using
The versions passed to ``pyenv local`` must be
`installed <https://github.com/yyuu/pyenv/blob/master/COMMANDS.md#pyenv-install>`__
for this to work. Check out the list of python versions that are
pre-installed in the CircleCI build environment:
https://circleci.com/docs/environment#python
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>`__
###############################################################################
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: ini
Expand All @@ -42,16 +41,64 @@ versions of python have been
`pyenv install <https://github.com/yyuu/pyenv/blob/master/COMMANDS.md#pyenv-install>`__\ed.

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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Here is the list of python versions that are *pre-installed* in the
CircleCI build environment (as of 09/27/2017):

::

$ pyenv versions
system
2.6.6
2.6.8
2.7
2.7.10
2.7.11
2.7.3
2.7.4
2.7.5
2.7.6
2.7.7
2.7.8
* 2.7.9 (set by /home/ubuntu/.pyenv/version)
3.1.5
3.2
3.2.5
3.3.0
3.3.2
3.3.3
3.4.0
3.4.1
3.4.2
3.4.3
3.5.0
pypy-2.2.1
pypy-2.3.1
pypy-2.4.0
pypy-2.5.0

If the version you need isn't in the list, such as Python ``3.6-dev``
include an ``install`` step:

::

dependencies:
override:
- pip install tox tox-pyenv
- pyenv install --skip-existing 3.6-dev
- pyenv local 3.6-dev

.. |latest| image:: https://img.shields.io/pypi/v/tox-pyenv.svg
:target: https://pypi.python.org/pypi/tox-pyenv
.. |Circle CI| image:: https://circleci.com/gh/samstav/tox-pyenv/tree/master.svg?style=shield
:target: https://circleci.com/gh/samstav/tox-pyenv/tree/master

0 comments on commit 09bc593

Please sign in to comment.