bucket_35/python-pytest-runner

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-pytest-runner
   4 VERSION=                6.0.1
   5 KEYWORDS=               python
   6 VARIANTS=               v11 v12
   7 SDESC[v11]=             Scripts to add setup.py test support (3.11)
   8 SDESC[v12]=             Scripts to add setup.py test support (3.12)
   9 HOMEPAGE=               https://github.com/pytest-dev/pytest-runner/
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPIWHL/23/2b/73982c02d28538b6a1182c0a2faf764ca6a76a6dbe89a69288184051a67b
  14 DISTFILE[1]=            pytest_runner-6.0.1-py3-none-any.whl:main
  15 DF_INDEX=               1
  16 SPKGS[v11]=             single
  17 SPKGS[v12]=             single
  18
  19 OPTIONS_AVAILABLE=      PY311 PY312
  20 OPTIONS_STANDARD=       none
  21 VOPTS[v11]=             PY311=ON PY312=OFF
  22 VOPTS[v12]=             PY311=OFF PY312=ON
  23
  24 DISTNAME=               pytest_runner-6.0.1.dist-info
  25
  26 GENERATED=              yes
  27
  28 [PY311].USES_ON=                        python:v11,wheel
  29
  30 [PY312].USES_ON=                        python:v12,wheel
  31
  32 [FILE:3290:descriptions/desc.single]
  33
  34
  35    :alt: tests
  36
  37    :alt: Code style: Black
  38
  39 Setup scripts can use pytest-runner to add setup.py test support for pytest
  40 runner.
  41
  42 Deprecation Notice
  43 ==================
  44
  45 pytest-runner depends on deprecated features of setuptools and relies on
  46 features that break security
  47 mechanisms in pip. For example 'setup_requires' and 'tests_require' bypass
  48 ``pip --require-hashes``.
  49 See also `pypa/setuptools#1684
  50 <https://github.com/pypa/setuptools/issues/1684>`_.
  51
  52 It is recommended that you:
  53
  54 - Remove ``'pytest-runner' from your setup_requires``, preferably removing
  55 the setup_requires option.
  56 - Remove 'pytest' and any other testing requirements from tests_require,
  57 preferably removing the tests_requires option.
  58 - Select a tool to bootstrap and then run tests such as tox.
  59
  60 Usage
  61 =====
  62
  63 - Add 'pytest-runner' to your 'setup_requires'. Pin to '>=2.0,<3dev' (or
  64   similar) to avoid pulling in incompatible versions.
  65 - Include 'pytest' and any other testing requirements to 'tests_require'.
  66 - Invoke tests with ``setup.py pytest``.
  67 - Pass ``--index-url`` to have test requirements downloaded from an
  68 alternate
  69   index URL (unnecessary if specified for easy_install in setup.cfg).
  70 - Pass additional py.test command-line options using ``--addopts``.
  71 - Set permanent options for the ``python setup.py pytest`` command (like
  72 ``index-url``)
  73   in the ``[pytest] section of setup.cfg``.
  74 - Set permanent options for the ``py.test`` run (like addopts or
  75 pep8ignore) in the ``[pytest]
  76   section of pytest.ini or tox.ini or put them in the [tool:pytest]
  77   section of setup.cfg``. See [pytest issue 567
  78  ].
  79 - Optionally, set ``test=pytest in the [aliases] section of setup.cfg
  80   to cause python setup.py test`` to invoke pytest.
  81
  82 Example
  83 =======
  84
  85 The most simple usage looks like this in setup.py::
  86
  87     setup(
  88         setup_requires=[
  89             'pytest-runner',
  90        ],
  91         tests_require=[
  92             'pytest',
  93        ],
  94     )
  95
  96 Additional dependencies require to run the tests (e.g. mock or pytest
  97 plugins) may be added to tests_require and will be downloaded and
  98 required by the session before invoking pytest.
  99
 100 Follow [this search on github
 101 ]
 102 for examples of real-world usage.
 103
 104 Standalone Example
 105 ==================
 106
 107 This technique is deprecated - if you have standalone scripts
 108 you wish to invoke with dependencies, `use pip-run
 109 <https://pypi.org/project/pip-run>`_.
 110
 111 Although ``pytest-runner`` is typically used to add pytest test
 112 runner support to maintained packages, ``pytest-runner`` may
 113 also be used to create standalone tests. Consider [this example
 114 failure],
 115 reported in `jsonpickle #117
 116 <https://github.com/jsonpickle/jsonpickle/issues/117>`_
 117 or [this MongoDB test
 118 ]
 119 demonstrating a technique that works even when dependencies
 120 are required in the test.
 121
 122 Either example file may be cloned or downloaded and simply run on
 123 any system with Python and Setuptools. It will download the
 124 specified dependencies and run the tests. Afterward, the the
 125 cloned directory can be removed and with it all trace of
 126 invoking the test. No other dependencies are needed and no
 127 system configuration is altered.
 128
 129 Then, anyone trying to replicate the failure can do so easily
 130 and with all the power of pytest (rewritten assertions,
 131 rich comparisons, interactive debugging, extensibility through
 132 plugins, etc).
 133
 134
 135 [FILE:115:distinfo]
 136 ea326ed6f6613992746062362efab70212089a4209c08d67177b3df1c52cd9f2         7186 pytest_runner-6.0.1-py3-none-any.whl
 137