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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
====================
Packaging guidelines
====================
Downstream packagers often want to package Hypothesis. Here are some guidelines.
The primary guideline is this: If you are not prepared to keep up with the Hypothesis release schedule,
don't. You will be doing your users a disservice.
Hypothesis has a very frequent release schedule. We often release new versions multiple times a week.
If you *are* prepared to keep up with this schedule, you might find the rest of this document useful.
----------------
Release tarballs
----------------
These are available from :gh-link:`the GitHub releases page <releases>`. The
tarballs on PyPI are intended for installation from a Python tool such as :pypi:`pip` and should not
be considered complete releases. Requests to include additional files in them will not be granted. Their absence
is not a bug.
------------
Dependencies
------------
~~~~~~~~~~~~~~~
Python versions
~~~~~~~~~~~~~~~
Hypothesis is designed to work with a range of Python versions - we support
`all versions of CPython with upstream support <https://devguide.python.org/#status-of-python-branches>`_.
We also support the latest versions of PyPy for Python 3.
~~~~~~~~~~~~~~~~~~~~~~
Other Python libraries
~~~~~~~~~~~~~~~~~~~~~~
Hypothesis has *mandatory* dependencies on the following libraries:
* :pypi:`attrs`
* :pypi:`sortedcontainers`
Hypothesis has *optional* dependencies on the following libraries:
.. literalinclude:: ../pyproject.toml
:prepend: [project.optional-dependencies]
:start-after: [project.optional-dependencies]
:end-before: # Avoid changing this by hand
The way this works when installing Hypothesis normally is that these features become available if the relevant
library is installed.
Specifically for :pypi:`pytest`, our plugin supports versions of pytest which
have been out of upstream support for some time. Hypothesis tests can still
be executed by even older versions of pytest - you just won't have the plugin
to provide automatic marks, helpful usage warnings, and per-test statistics.
------------------
Testing Hypothesis
------------------
If you want to test Hypothesis as part of your packaging you will probably not want to use the mechanisms
Hypothesis itself uses for running its tests, because it has a lot of logic for installing and testing against
different versions of Python.
The tests must be run with fairly recent tooling; check the :gh-link:`tree/master/requirements/`
directory for details.
The organisation of the tests is described in the :gh-file:`hypothesis-python/tests/README.rst`.
--------
Examples
--------
* `arch linux <https://archlinux.org/packages/extra/any/python-hypothesis/>`_
* `fedora <https://src.fedoraproject.org/rpms/python-hypothesis>`_
* `gentoo <https://packages.gentoo.org/packages/dev-python/hypothesis>`_
|
