summaryrefslogtreecommitdiff
path: root/README
blob: 55cde0a3c77d2992ecce6ae3c769d62c4443c41c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
pytest-runner
=============

Setup scripts can use pytest-runner to add setup.py test support for pytest
runner.

Usage
-----

- Add 'pytest-runner' to your 'setup_requires'. Pin to '>=2.0,<3dev' (or
  similar) to avoid pulling in incompatible versions.
- Include 'pytest' and any other testing requirements to 'tests_require'.
- Invoke tests with `setup.py pytest`.
- Pass `--index-url` to have test requirements downloaded from an alternate
  index URL.
- Pass additional py.test command-line options using `--addopts`.
- Set options in the `[pytest]` section of setup.cfg.

See the `jaraco.util <https://bitbucket.org/jaraco/jaraco.util/>`_ project
for an example.

Changes
-------

2.2
~~~

* Honor ``.eggs`` directory for transient downloads as introduced in Setuptools
  7.0.

2.1
~~~

* The preferred invocation is now the 'pytest' command.

2.0
~~~

* Removed support for the alternate usage. The recommended usage (as a
  distutils command) is now the only supported usage.
* Removed support for the --junitxml parameter to the ptr command. Clients
  should pass the same parameter (and all other py.test arguments) to py.test
  via the --addopts parameter.

1.1
~~~

* Added support for --addopts to pass any arguments through to py.test.
* Deprecated support for --junitxml. Use --addopts instead. --junitxml will be
  removed in 2.0.

1.0
~~~

Initial implementation.