Skip to content

Commit

Permalink
Tox -> tox (#591)
Browse files Browse the repository at this point in the history
* #589 change all incidences of "Tox" to "tox" in docs and output
  • Loading branch information
obestwalter authored Sep 4, 2017
1 parent 952385a commit e8891a5
Show file tree
Hide file tree
Showing 10 changed files with 41 additions and 37 deletions.
16 changes: 10 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@

What is Tox?
--------------------

tox automation project
----------------------

.. image:: https://img.shields.io/pypi/v/tox.svg
:target: https://pypi.org/project/tox/
Expand All @@ -12,8 +10,14 @@ What is Tox?
.. image:: https://img.shields.io/appveyor/ci/RonnyPfannschmidt/tox/master.svg
:target: https://ci.appveyor.com/project/RonnyPfannschmidt/tox

**vision: standardize testing in Python**

tox aims to automate and standardize testing in Python. It is part of a larger vision of easing the packaging, testing and release process of Python software.

What is tox?
------------

Tox is a generic virtualenv management and test command line tool you can use for:
tox is a generic virtualenv management and test command line tool you can use for:

* checking your package installs correctly with different Python versions and
interpreters
Expand All @@ -23,7 +27,7 @@ Tox is a generic virtualenv management and test command line tool you can use fo
* acting as a frontend to Continuous Integration servers, greatly
reducing boilerplate and merging CI and shell-based testing.

For more information and the repository please checkout:
For more information and the repository please see:

- home and docs: https://tox.readthedocs.org

Expand Down
4 changes: 2 additions & 2 deletions doc/config-v2.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ their python projects.
Issues with current tox (1.4) configuration
------------------------------------------------

Tox is used as a tool for creating and managing virtualenv environments
tox is used as a tool for creating and managing virtualenv environments
and running tests in them. As of tox-1.4 there are some issues frequently
coming up with its configuration language:

Expand Down Expand Up @@ -124,7 +124,7 @@ Nothing special here :)

.. note::

Tox provides good defaults for platform and basepython
tox provides good defaults for platform and basepython
settings, so the above ini-file can be further reduced::

[tox]
Expand Down
8 changes: 4 additions & 4 deletions doc/config.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tox configuration specification
Below you find the specification, but you might want to skim some
:doc:`examples` first and use this page as a reference.

Tox global settings
tox global settings
-------------------

List of optional global options::
Expand Down Expand Up @@ -135,8 +135,8 @@ Complete list of settings that you can put into ``testenv*`` sections:
similarity in function.

Note that in tox 2.0, the default behavior of tox with respect to
treating errors from commands changed. Tox < 2.0 would ignore errors by
default. Tox >= 2.0 will abort on an error by default, which is safer and more
treating errors from commands changed. tox < 2.0 would ignore errors by
default. tox >= 2.0 will abort on an error by default, which is safer and more
typical of CI and command execution tools, as it doesn't make sense to
run tests if installing some prerequisite failed and it doesn't make sense to
try to deploy if tests failed.
Expand Down Expand Up @@ -615,7 +615,7 @@ Reading it line by line:

.. note::

Tox provides good defaults for basepython setting, so the above
tox provides good defaults for basepython setting, so the above
ini-file can be further reduced by omitting the ``basepython``
setting.

Expand Down
6 changes: 3 additions & 3 deletions doc/example/basic.txt
Original file line number Diff line number Diff line change
Expand Up @@ -227,12 +227,12 @@ special handling of PYTHONHASHSEED

.. versionadded:: 1.6.2

By default, Tox sets PYTHONHASHSEED_ for test commands to a random integer
By default, tox sets PYTHONHASHSEED_ for test commands to a random integer
generated when ``tox`` is invoked. This mimics Python's hash randomization
enabled by default starting `in Python 3.3`_. To aid in reproducing test
failures, Tox displays the value of ``PYTHONHASHSEED`` in the test output.
failures, tox displays the value of ``PYTHONHASHSEED`` in the test output.

You can tell Tox to use an explicit hash seed value via the ``--hashseed``
You can tell tox to use an explicit hash seed value via the ``--hashseed``
command-line option to ``tox``. You can also override the hash seed value
per test environment in ``tox.ini`` as follows::

Expand Down
2 changes: 1 addition & 1 deletion doc/example/devenv.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Development environment
=======================

Tox can be used for just preparing different virtual environments required by a
tox can be used for just preparing different virtual environments required by a
project.

This feature can be used by deployment tools when preparing deployed project
Expand Down
2 changes: 1 addition & 1 deletion doc/example/general.txt
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ the following entry::
deps=
{distshare}/one-*.zip # install latest package from "one" project

That's all. Tox running on project ``one`` will copy the sdist-package
That's all. tox running on project ``one`` will copy the sdist-package
into the ``distshare`` directory after which a ``tox`` run on project
``two`` will grab it because ``deps`` contain an entry with the
``one-*.zip`` pattern. If there is more than one matching package the
Expand Down
2 changes: 1 addition & 1 deletion doc/example/jenkins.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

Using Tox with the Jenkins Integration Server
Using tox with the Jenkins Integration Server
=================================================

Using Jenkins multi-configuration jobs
Expand Down
4 changes: 2 additions & 2 deletions doc/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ vision: standardize testing in Python
of a larger vision of easing the packaging, testing and release process
of Python software.

What is Tox?
What is tox?
--------------------

Tox is a generic virtualenv_ management and test command line tool you can use for:
tox is a generic virtualenv_ management and test command line tool you can use for:

* checking your package installs correctly with different Python versions and
interpreters
Expand Down
30 changes: 15 additions & 15 deletions tests/test_quickstart.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ def test_quickstart_main_choose_individual_pythons_and_pytest(
tox._quickstart.main(argv=['tox-quickstart'])

expected_tox_ini = """
# Tox (https://tox.readthedocs.io/) is a tool for running tests
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
Expand Down Expand Up @@ -92,7 +92,7 @@ def test_quickstart_main_choose_individual_pythons_and_nose_adds_deps(
tox._quickstart.main(argv=['tox-quickstart'])

expected_tox_ini = """
# Tox (https://tox.readthedocs.io/) is a tool for running tests
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
Expand Down Expand Up @@ -134,7 +134,7 @@ def test_quickstart_main_choose_individual_pythons_and_trial_adds_deps(
tox._quickstart.main(argv=['tox-quickstart'])

expected_tox_ini = """
# Tox (https://tox.readthedocs.io/) is a tool for running tests
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
Expand Down Expand Up @@ -175,7 +175,7 @@ def test_quickstart_main_choose_individual_pythons_and_pytest_adds_deps(
tox._quickstart.main(argv=['tox-quickstart'])

expected_tox_ini = """
# Tox (https://tox.readthedocs.io/) is a tool for running tests
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
Expand Down Expand Up @@ -208,7 +208,7 @@ def test_quickstart_main_choose_py27_and_pytest_adds_deps(
tox._quickstart.main(argv=['tox-quickstart'])

expected_tox_ini = """
# Tox (https://tox.readthedocs.io/) is a tool for running tests
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
Expand Down Expand Up @@ -241,7 +241,7 @@ def test_quickstart_main_choose_py27_and_py33_and_pytest_adds_deps(
tox._quickstart.main(argv=['tox-quickstart'])

expected_tox_ini = """
# Tox (https://tox.readthedocs.io/) is a tool for running tests
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
Expand Down Expand Up @@ -274,7 +274,7 @@ def test_quickstart_main_choose_all_pythons_and_pytest_adds_deps(
tox._quickstart.main(argv=['tox-quickstart'])

expected_tox_ini = """
# Tox (https://tox.readthedocs.io/) is a tool for running tests
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
Expand Down Expand Up @@ -316,7 +316,7 @@ def test_quickstart_main_choose_individual_pythons_and_defaults(
tox._quickstart.main(argv=['tox-quickstart'])

expected_tox_ini = """
# Tox (https://tox.readthedocs.io/) is a tool for running tests
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
Expand Down Expand Up @@ -363,7 +363,7 @@ def test_quickstart_main_existing_tox_ini(self, monkeypatch):
tox._quickstart.main(argv=['tox-quickstart'])

expected_tox_ini = """
# Tox (https://tox.readthedocs.io/) is a tool for running tests
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
Expand Down Expand Up @@ -402,7 +402,7 @@ def test_quickstart_main_tox_ini_location_can_be_overridden(
assert tox_ini_path.isfile()

expected_tox_ini = """
# Tox (https://tox.readthedocs.io/) is a tool for running tests
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
Expand Down Expand Up @@ -444,7 +444,7 @@ def test_quickstart_main_custom_tox_ini_location_with_existing_tox_ini(
assert tox_ini_path.isfile()

expected_tox_ini = """
# Tox (https://tox.readthedocs.io/) is a tool for running tests
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
Expand Down Expand Up @@ -493,7 +493,7 @@ def test_pytest(self):
'deps': 'pytest',
}
expected_tox_ini = """
# Tox (https://tox.readthedocs.io/) is a tool for running tests
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
Expand All @@ -520,7 +520,7 @@ def test_setup_py_test(self):
'deps': '',
}
expected_tox_ini = """
# Tox (https://tox.readthedocs.io/) is a tool for running tests
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
Expand All @@ -546,7 +546,7 @@ def test_trial(self):
'deps': 'Twisted',
}
expected_tox_ini = """
# Tox (https://tox.readthedocs.io/) is a tool for running tests
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
Expand Down Expand Up @@ -577,7 +577,7 @@ def test_nosetests(self):
'deps': 'nose',
}
expected_tox_ini = """
# Tox (https://tox.readthedocs.io/) is a tool for running tests
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
Expand Down
4 changes: 2 additions & 2 deletions tox/_quickstart.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
PROMPT_PREFIX = '> '

QUICKSTART_CONF = '''\
# Tox (https://tox.readthedocs.io/) is a tool for running tests
# tox (https://tox.readthedocs.io/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.
Expand Down Expand Up @@ -148,7 +148,7 @@ def ask_user(d):
"""

print('Welcome to the Tox %s quickstart utility.' % __version__)
print('Welcome to the tox %s quickstart utility.' % __version__)
print('''
This utility will ask you a few questions and then generate a simple tox.ini
file to help get you started using tox.
Expand Down

0 comments on commit e8891a5

Please sign in to comment.