Skip to main content

Invoke py.test as distutils command with dependency resolution.

Project description

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


  • 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 pytest.
  • Pass --index-url to have test requirements downloaded from an alternate index URL.
  • Pass additional py.test command-line options using --addopts.
  • Set permanent options for the pytest distutils command in the [pytest] section of setup.cfg.
  • Set permanent options for the pytest run itself in the [pytest] section of pytest.ini or tox.ini. See pytest 567 for details on why setup.cfg is inadequate.
  • Optionally, set test=pytest in the [aliases] section of setup.cfg to cause test to invoke pytest.


See the jaraco.collections project for example usage.


Conditional Requirement

Because it uses Setuptools setup_requires, pytest-runner will install itself on every invocation of In some cases, this causes delays for invocations of that will never invoke pytest-runner. To help avoid this contingency, consider requiring pytest-runner only when pytest is invoked:

needs_pytest = {'pytest', 'test', 'ptr'}.intersection(sys.argv)
pytest_runner = ['pytest_runner'] if needs_pytest else []

# ...

            #... (other setup requirements)
    ] + pytest_runner,



  • Use hgdistver for version management and file discovery.


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


  • The preferred invocation is now the ‘pytest’ command.


  • 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.


  • 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.


Initial implementation.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date (6.0 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page