Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix badge link and code formatting #2053

Merged
merged 3 commits into from
May 2, 2021
Merged

Fix badge link and code formatting #2053

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
757520c
Fix badge link and code formatting
hugovk May 1, 2021
f1fc9ab
Update CONTRIBUTORS
hugovk May 1, 2021
d1e5566
Update CONTRIBUTORS
hugovk May 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CONTRIBUTORS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Gleb Nikonorov
Gonéri Le Bouder
Hazal Ozturk
Henk-Jaap Wagenaar
Hugo van Kemenad
hugovk marked this conversation as resolved.
Show resolved Hide resolved
Ian Stapleton Cordasco
Igor Duarte Cardoso
Ilya Kulakov
Expand Down
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![PyPI](https://img.shields.io/pypi/v/tox?style=flat-square)
[![PyPI](https://img.shields.io/pypi/v/tox?style=flat-square)](https://pypi.org/project/tox/)
[![Supported Python
versions](https://img.shields.io/pypi/pyversions/tox.svg)](https://pypi.org/project/tox/)
[![Azure Pipelines build
Expand Down Expand Up @@ -33,7 +33,7 @@ the configuration.

To test a simple project that has some tests, here is an example with a `tox.ini` in the root of the project:

```{.sourceCode .ini}
```ini
[tox]
envlist = py37,py38

Expand All @@ -42,7 +42,7 @@ deps = pytest
commands = pytest
```

```{.sourceCode .console}
```console
$ tox

[lots of output from what tox does]
Expand All @@ -54,7 +54,7 @@ __________________ summary _________________
congratulations :)
```

tox created two `testenvs` - one based on Python3.7 and one based on Python3.8, it installed pytest in them and ran the
tox created two `testenvs` - one based on Python 3.7 and one based on Python 3.8, it installed pytest in them and ran the
tests. The report at the end summarizes which `testenvs` have failed and which have succeeded.

**Note:** To learn more about what you can do with tox, have a look at
Expand All @@ -63,7 +63,7 @@ tests. The report at the end summarizes which `testenvs` have failed and which h

### How it works

tox creates virtual environments for all configured so called `testenvs`, it then installs the project and other
tox creates virtual environments for all configured so-called `testenvs`, it then installs the project and other
necessary dependencies and runs the configured set of commands. See
[system overview](https://tox.readthedocs.io/en/latest/#system-overview) for more details.

Expand All @@ -79,7 +79,7 @@ necessary dependencies and runs the configured set of commands. See
- creating development environments
- running static code analysis and test tools
- automating package builds
- running tests against the package build by tox
- running tests against the package built by tox
- checking that packages install correctly with different Python versions/interpreters
- unifying Continuous Integration and command line based testing
- building and deploying project documentation
Expand Down