Skip to content

Commit e8891a5

Browse files
authored
Tox -> tox (#591)
* #589 change all incidences of "Tox" to "tox" in docs and output
1 parent 952385a commit e8891a5

10 files changed

+41
-37
lines changed

README.rst

+10-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
2-
What is Tox?
3-
--------------------
4-
1+
tox automation project
2+
----------------------
53

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

13+
**vision: standardize testing in Python**
14+
15+
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.
16+
17+
What is tox?
18+
------------
1519

16-
Tox is a generic virtualenv management and test command line tool you can use for:
20+
tox is a generic virtualenv management and test command line tool you can use for:
1721

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

26-
For more information and the repository please checkout:
30+
For more information and the repository please see:
2731

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

doc/config-v2.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ their python projects.
1818
Issues with current tox (1.4) configuration
1919
------------------------------------------------
2020

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

@@ -124,7 +124,7 @@ Nothing special here :)
124124

125125
.. note::
126126

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

130130
[tox]

doc/config.txt

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ tox configuration specification
99
Below you find the specification, but you might want to skim some
1010
:doc:`examples` first and use this page as a reference.
1111

12-
Tox global settings
12+
tox global settings
1313
-------------------
1414

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

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

616616
.. note::
617617

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

doc/example/basic.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -227,12 +227,12 @@ special handling of PYTHONHASHSEED
227227

228228
.. versionadded:: 1.6.2
229229

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

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

doc/example/devenv.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Development environment
33
=======================
44

5-
Tox can be used for just preparing different virtual environments required by a
5+
tox can be used for just preparing different virtual environments required by a
66
project.
77

88
This feature can be used by deployment tools when preparing deployed project

doc/example/general.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ the following entry::
113113
deps=
114114
{distshare}/one-*.zip # install latest package from "one" project
115115

116-
That's all. Tox running on project ``one`` will copy the sdist-package
116+
That's all. tox running on project ``one`` will copy the sdist-package
117117
into the ``distshare`` directory after which a ``tox`` run on project
118118
``two`` will grab it because ``deps`` contain an entry with the
119119
``one-*.zip`` pattern. If there is more than one matching package the

doc/example/jenkins.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
Using Tox with the Jenkins Integration Server
2+
Using tox with the Jenkins Integration Server
33
=================================================
44

55
Using Jenkins multi-configuration jobs

doc/index.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ vision: standardize testing in Python
88
of a larger vision of easing the packaging, testing and release process
99
of Python software.
1010

11-
What is Tox?
11+
What is tox?
1212
--------------------
1313

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

1616
* checking your package installs correctly with different Python versions and
1717
interpreters

tests/test_quickstart.py

+15-15
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ def test_quickstart_main_choose_individual_pythons_and_pytest(
5050
tox._quickstart.main(argv=['tox-quickstart'])
5151

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

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

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

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

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

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

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

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

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

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

446446
expected_tox_ini = """
447-
# Tox (https://tox.readthedocs.io/) is a tool for running tests
447+
# tox (https://tox.readthedocs.io/) is a tool for running tests
448448
# in multiple virtualenvs. This configuration file will run the
449449
# test suite on all supported python versions. To use it, "pip install tox"
450450
# and then run "tox" from this directory.
@@ -493,7 +493,7 @@ def test_pytest(self):
493493
'deps': 'pytest',
494494
}
495495
expected_tox_ini = """
496-
# Tox (https://tox.readthedocs.io/) is a tool for running tests
496+
# tox (https://tox.readthedocs.io/) is a tool for running tests
497497
# in multiple virtualenvs. This configuration file will run the
498498
# test suite on all supported python versions. To use it, "pip install tox"
499499
# and then run "tox" from this directory.
@@ -520,7 +520,7 @@ def test_setup_py_test(self):
520520
'deps': '',
521521
}
522522
expected_tox_ini = """
523-
# Tox (https://tox.readthedocs.io/) is a tool for running tests
523+
# tox (https://tox.readthedocs.io/) is a tool for running tests
524524
# in multiple virtualenvs. This configuration file will run the
525525
# test suite on all supported python versions. To use it, "pip install tox"
526526
# and then run "tox" from this directory.
@@ -546,7 +546,7 @@ def test_trial(self):
546546
'deps': 'Twisted',
547547
}
548548
expected_tox_ini = """
549-
# Tox (https://tox.readthedocs.io/) is a tool for running tests
549+
# tox (https://tox.readthedocs.io/) is a tool for running tests
550550
# in multiple virtualenvs. This configuration file will run the
551551
# test suite on all supported python versions. To use it, "pip install tox"
552552
# and then run "tox" from this directory.
@@ -577,7 +577,7 @@ def test_nosetests(self):
577577
'deps': 'nose',
578578
}
579579
expected_tox_ini = """
580-
# Tox (https://tox.readthedocs.io/) is a tool for running tests
580+
# tox (https://tox.readthedocs.io/) is a tool for running tests
581581
# in multiple virtualenvs. This configuration file will run the
582582
# test suite on all supported python versions. To use it, "pip install tox"
583583
# and then run "tox" from this directory.

tox/_quickstart.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
PROMPT_PREFIX = '> '
6363

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

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

0 commit comments

Comments
 (0)