Skip to content

Commit 695ea27

Browse files
committed
Update install instructions
1 parent 3648042 commit 695ea27

File tree

2 files changed

+177
-18
lines changed

2 files changed

+177
-18
lines changed

doc/src/08A1264175343E6E.pub

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
-----BEGIN PGP PUBLIC KEY BLOCK-----
2+
3+
mQINBFgqIDYBEADs08vJtPmKgfaSkKTtHWaYOmCchuXtaTd766b3tDaL55XfTucS
4+
OGVUk1hbaMl8aAZoEmwCDIIMFUGL21QNdZTPLOWv29qXNnUjQEB7vUoJvafZPzTh
5+
+38PDkOeLCQ67J/OSHkRQvEFGc6EXNo/GbtZ1oAGQXFeMbcFg7EuEQvEbHxyJAMo
6+
6a+q9fHB/YkTJVkMFkPnBw2Lbywa5LVJ6ZZWk+IyxbeIZhcjTkpaZMSQhNJAF14q
7+
4uKOGhVupfKZmvwnEvrNwp5ImTiiu6mRuywVDwxXUVersCuIhL/ZQeKI1ImboxW3
8+
v3p0msxzPaGi0tyb4H7mi/W5rat0u+Zm2EaxYjJDADaNSluxZweUgCi2V/tCzZtP
9+
FgnElFYPHphay8rZ8bbcw5YfcFrC9tdF0sDD1p7qmpOnVlKPw67RwS148+ew7sxy
10+
gW56qJP6AgbVVInJU2XNziphpPBbOYkPhYEa0HsAO62ubESPHJHTHuaMe0m+BbNh
11+
bS2jtPrCaSC5ci6fsVsz0nl5zIFmpDOWKzHNjl5rCcQeV6WXCXeW+f8OfFTe0BXb
12+
nn2qTq2nY+QMNXMiJ0RKwD/XCCphXLlkN5Oflt3JBAEMFMDbptUf8Zd74+xrdjQj
13+
byFu3FLB+3h1oMX+7heoul4LQVbE/qH/fkUIPsSky51I4XWLlgnVy1PQKwARAQAB
14+
tB1Sb2xmIEtyYWhsIDxyb2xmQHJvdGtyYXV0LmRlPokCPAQTAQIAJgIbAwcLCQgH
15+
AwIBBhUIAgkKCwQWAgMBAh4BAheABQJYKisKAhkBAAoJEAihJkF1ND5uLzQQALnu
16+
VyxylxLRlSQ16KAA8mfX2BVcC+3IMj9IyYYIj5Vt7BXbFtBS+sAKQ9sqXVpHzob0
17+
s5Rfat6sFimO0TDeNlhnS1hRZ1USQJUJ+V8c3L6OmpyNemG3/6Qi0iNYazfE71TA
18+
Km4mW3wgPq8H0/hnKe7tEggPkrhENbo7JDideQ1wAVT9KFu49M2Vm80hUVHiEQh+
19+
1VbThRmzJjINCiYALcHMo7ZO5uNBenn9zetlKAYpLnRApmPuyAi0jisheJs1gap5
20+
EtDbcxsD1bqtOKVnJIWqAB7yJDThdDENyo93y2w9BMycobNl3eL7MoB6Ep+Rc8Ae
21+
XIF/HwFtK0j84B+2dUvUHOQZuX3Qtlgu1FenwlOe8u0nwwur1q/Nz7YWg7anagn9
22+
yA+uDAsO5eclGAqTT5PHjSaEiPtANmRRKijCeHjB7OVTgtT1nY6ThFurDeFnk55J
23+
mTmcaQg9ZPSKeCfWwC+BX+p/9V9Pz5LVa9tyFdxHJERxze4CrwcQkQLFSH+CavLa
24+
iWDLyiAydEa0XU6MU5EmrkwUIHLKzC7ZzwuLkQhC8PXZCifTSkHP7gH4uUUMo2nK
25+
6JQnRC+ylOlyBWSVlzkhYXlKcAbmrw095z70OKx4GVFyBfi3PLjceHjNvA/QPCQR
26+
FIEh65MUYDtSz7LpUwvFYUWVFSuV7zzHlHiT3kYIiEYEExECAAYFAlgqLe8ACgkQ
27+
UcvGPyCdlGbVYwCfYse0zET860S+E71M3Tlfp4brzOIAoOlm+m7wGU6DzTjGyGCa
28+
zPLpoBq4iQEcBBMBAgAGBQJYKi5TAAoJEIPzNkMsf8yRK+sIAKC9HqZY/f5po06Z
29+
gy1rWF5qDBA5GxehwYiD3kZ1EhbINjPbujNLIvpzTce2T4mhu1Ibk8fahu/Viwjy
30+
7n0b0zf9xSiQuUVftopHOf0jfx7oGCVTOMbcENV/UN7SoXCBiKMDDlcfd9Kdt8Ft
31+
nGyqxod3snJMn6G1VKTBCyLECh7BvyBE4oOQhyPgFYrIKwymOq+mBSPd9j3QjvRu
32+
xpqteVOr32IYDYNbcxPIu2q6uydnjZxXdlvuo0xl8wwJgka4zGKj0DboajZyMEvR
33+
OKbs5dQ6pwzRnxvJMxWSB/q4MOWOvtJcVyJP2eYLgE/dcMgN8UgUUjkcJ8G2eSv2
34+
DgunBHu0H1JvbGYgS3JhaGwgPHJvbGZAdW5pLWJyZW1lbi5kZT6JAjkEEwECACMF
35+
AlgqIb8CGwMHCwkIBwMCAQYVCAIJCgsEFgIDAQIeAQIXgAAKCRAIoSZBdTQ+biHz
36+
D/4pB8FRxJdNYegk5B1HlwzKBrmR/9HW6iJa4MinxOyiPNew3mQRzw/FBM9w1F8h
37+
TL5s+28u/swjwntNLbI5QMYQ+JcSRgmkmzP0lPSS0i+fPm/QjpAsZ/8HTAIUIVPX
38+
6HHOUbCtcqKVePeSIxuubF0QX2dB4uu2BhEdOcaqBkopL0QMTZx4qAaGfh0tKWc5
39+
Q6genqXmD24cCSezfGwnQrd/2KvgyWkf7OltZHnyOUmoaAamujkttbtVETeybbY7
40+
GG73nc/Nv40ypzLQmqK6GK2pUmMoM2k3KdsInxTuBWsKjcGLU/FfvPSMsXwaaCHx
41+
N+QByU1d3rc/RDkrw6oHnrGqXQDwvKGpJ3bcAaUpshI/ywRPUUiMOlUPvmMHg4wV
42+
nKSrwJs+9hsf6v930E3Wku3Ohuqf8I7AaMFSSop8McemZQuoMgGSzCuF8rdOlvgj
43+
wY6mOuQ8jSUtvNi6+8NC+tL1DM4p90fx/kn4vI6TJ+34lZ/hMiRj6JH4bbTLEfdS
44+
PL3M3vmh7xl6im2WsBnJaCFpmml7sgIGWIoy8A8dAOEkfmb7kZtGYZwqBSIex4Hu
45+
WdfeEQifzoxBX2YAJjYdMJUUf217+x06s1ML4uChg9csBrphXnMmTzHFXsdI78hh
46+
Cf/f7I/o+mAO49ww4DaZV1SQXjoFQ6iCamsiJaH1nKhnXYhGBBMRAgAGBQJYKi30
47+
AAoJEFHLxj8gnZRmG5AAoOM1SRMiNBJeR5OeYwsBGuan0ElmAJ4sb+N0emeAImsJ
48+
k1JH3Fuht4/ixIkBGwQTAQIABgUCWCouWAAKCRCD8zZDLH/MkZFMB/QMFHwGT1km
49+
DFDmZKkChCWnL0P5aopsMaCxqx3Ru5aqO87QDRjLOHSK8Emt5sp0Pz1FGJxAUOby
50+
bCll0yG9qFSOU51QQQYEKUSELpMyT4/PdmzGPA8yYclrnq/BJ1cwPnZjw4soRZrL
51+
PiFRYvSb16PF29xGTQF0ejFjSnBnCMNGeoIExtlW5hyGwDoZ1cJgvOqd/o5hyy5D
52+
TxvEFtri0Bx3nCyGrERbH6HNP6Of0+D+MiH/IQKDkfMHaMiR1hHyb4facBALD66e
53+
1dZLp3eKDQdvVZBP2NGW+BOpVLG6Zs1tbGdVCXq6CJEG+zM3xFaUNtAXck09zub3
54+
IF+F44NY+yu0H1JvbGYgS3JhaGwgPFJvbGYuS3JhaGxAZ214Lm5ldD6JAjkEEwEC
55+
ACMFAlgqIZ4CGwMHCwkIBwMCAQYVCAIJCgsEFgIDAQIeAQIXgAAKCRAIoSZBdTQ+
56+
bjG8EADiP2oUqpgTz80cy193k7Lo+NEvcEkNgh7bc6W7dLwz7vL7cMBQ9K0qAQjq
57+
TeGHucOM5ju7iDDPOVhchRJFCRl+rg35WaFCmiDd2x4j8c28sSrI+znj9dw5vLfk
58+
8dShS6Ux6ocgLHwd5jh2ErAb3AKEGyVysA+0wydT/44jiLWjRSEF6qIDTmuxsc3L
59+
+/f2ZBHtwRMI2fHWuosXY7Wkb8XTq/4kGgEL/DJrs0AQv/Ww17hfQhf1SYAQSgEK
60+
DC90KsQzJzvAgsplQcJovwKFEgQUZ6ox5x/jhqnj1It0WYALJ4s0qUKOLqi+RKcZ
61+
swpBb0Aq45UMu0KJ+EKWtGG6snfu/d00K+KncS8qBav7ciZ5EP13TdKJNwOcKd8i
62+
NiSnP86yvNHZ5gST/++M8wB9NjhHbf50+JxQ0lJTg6o8rW2IdTjiHUXf5Z3YmwgS
63+
WmH7byhn1leTces2NfsCGKN6j6/0YwKUyOG8XpgAiY34TLXMZbI4zsV07aJY9vRY
64+
Vn45Co0nwOBbl3WMattWg94myQrIyMkEnETStzsO7s/jOIVW8bS4OXdOZg8DY9PE
65+
71k8XQA9Puc5NucYioFosyNWikGoU058qoTQzVXpSgoI9cdTniZGfHoguBqr7X2L
66+
NaX75L5dnwPepM1Z5iFl3P5aBB6rnkW5ZEkftXTOmt8doqj2SohGBBMRAgAGBQJY
67+
Ki30AAoJEFHLxj8gnZRmd1gAoIgAm3VJlohlxaxL4Rk4JaRSvjTcAKDEq8E7j6S6
68+
4f8JiP2sciLBjUR814kBHAQTAQIABgUCWCouWAAKCRCD8zZDLH/MkU9HB/4p5G0P
69+
O/u5P+hkiCPIZiiMo1DmvuQkQZEDqDobnHaxB5t2SyfdPyM9VJ5rOVSgXwYfxXSJ
70+
3A6eHW5sHtjWqa/eD0dosY+lVJPA/dbJ9RNCPU1YgpfOZSiYtJiAIC3kRd2e4mPW
71+
WwxJqXvTTy+T3aDwt1mfJR8SG1UP2+aiGCVbUWbo1y2EfHUBRc981pKCMERsgemh
72+
WggvRYNkbfyuSF5Mt32beXx91W7TE7hoivKsngzbO82taD9asCSFzmZn3C5BfYth
73+
E3iqb2EmSUbQkRzhfXk7RxoxY7RWeDodFXkRzVbwBXFY3Q7XfRNhtVA7d0O+zIWq
74+
p2DtvLsITicrQxS8uQINBFgqIDYBEADU/dsD2NXhQVQZL12c8Yt6Nj/Ma73B/SaP
75+
wSmyF7f0pPO3sLO0r5wOebolwbGytIh52G/7i1ZdFNJ+D06tbGNc5CUgkgcNTY+x
76+
ND4zazWoaooEsx2TPYqDqSmJbEjeDvr//QvCQ8x7ky1p/iAEvCuFSFiAH0HGXuBU
77+
MiM/MoBC7W3tyS9pbDy43+uphwO0A24Mrxem84zvHBFBFI/pinrp4laU1PMVaSSc
78+
q82ENCGjXhvF8Ummq1F1XclQ+pza+uGBChz6QMG8EB2WRlFQqoR9xa+K3UmC+UO6
79+
fAkMx8p/LAuAABGphAAGZc011yuYS9uCh9zNFyBOakqLJRP4+faRWxWkzD8d2Cq+
80+
9I9CpiM0a3bC56VKPFeic8Xwvd81wDIp39eha8OQpMvSZp54j84hDP83IBl8D/Yl
81+
vzKO3Xag1Eg0c92N1mNbLhV75oAbmUgOrJktg2bJjRaUOGN+KuwKUvTUawsIBIAW
82+
xIZP2rLhT21ffSEYC/TZYD39O748lUgcBDH/czTfH+pf1mapjOFaLD+c4lA/hN19
83+
Su6RqJ8oYTMNsFNWzMmUAsWrCSFnGFhXeOW6kH7AqJ6FMHnsAiCHuhJGKi0Qe76n
84+
wBDr0ut1XqELHK0hC+LJlHufbfsniuG8QqLzmmWr8aX64pyPU8FtB1hYG8tBjkqj
85+
fKIbRKnsBwARAQABiQIfBBgBAgAJBQJYKiA2AhsMAAoJEAihJkF1ND5uOoYQAIgg
86+
DsLqsjW0awdhf/nNK3haDbvYQhtmOmskcKQW7fQXHm0kqGoIliQN57fJNH88OT+9
87+
Rp6wYjKPblVSNIbcQ8M2nXEVkNtAtO7uC2WVcZeFNVQIsrXX22302riADy7IK51f
88+
RILnCdyrePehxfyscw0VhJIYDx76iZVM0lNKfuZj00CLXOG76V5/T1o4uu8UAVe5
89+
cW/astcA+u8pU2u7dyUMcaU9kK0rDz2HI+b1CMs+EGPnEVOqML+RxGTIufYUoqSX
90+
tWHXsMSWq6IK22A42m4E6HNtcNAKUK7jGLoOdHA0QaFVxHmajG+pUM9MWTcvZrsn
91+
ZFDlDhyqrF4LBPLG5vk+C4HxdOIEWC+X5GrdESjYWxv14M0ZxustEGkf5VQHdbgE
92+
W+RcqkwkEbiDjLoaFvOZu+NSy0EXxDtBTlkllBJMn01IAxAVgP8M7T/fZ7lg4uLz
93+
RBRhm0T9/IvWjAx0wsiNr45iJ++5sJCQWxU4lWFjSrACPzCY0fP2nDMMBfkn58w/
94+
r0/tDFumEvBXHCVzdhLzUbetrzmNwGaZdg14ahlEnbbhQktYc+rWbE+ObX74WwHk
95+
0ziR94MVr/9v144v0GuvBZaycUfe1ljHiPjMnjroODyZ48NjRWY83NolEaQhg+Zf
96+
BzxtQzjcEYPj7MEcrHXhzM7gQQ8wnzhc39eK6bKv
97+
=IIFi
98+
-----END PGP PUBLIC KEY BLOCK-----

doc/src/install.rst

Lines changed: 79 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,35 @@
11
Installation instructions
22
=========================
33

4+
See :ref:`install-using-pip` for the short version of the install
5+
instructions.
6+
7+
48
System requirements
59
-------------------
610

7-
+ Python 2.7 or 3.4 and newer.
11+
+ Python 3.4 or newer.
812
+ `setuptools`_.
913
+ `pytest`_ 3.7.0 or newer.
1014

15+
Optional library packages
16+
.........................
17+
18+
These packages are not needed to install or use pytest-dependency.
19+
They are mostly only needed by the maintainer.
20+
21+
+ `git-props`_
22+
23+
This package is used to extract some metadata such as the version
24+
number out of git, the version control system. All releases embed
25+
that metadata in the distribution. So this package is only needed
26+
to build out of the plain development source tree as cloned from
27+
GitHub, but not to build a release distribution.
28+
29+
+ `distutils-pytest`_ >= 0.2
30+
31+
Only needed to run the test suite.
32+
1133

1234
.. _install-other-packages:
1335

@@ -30,40 +52,79 @@ Interaction with other packages
3052
you do not enable parallelization in pytest-xdist.
3153

3254

33-
Download
34-
--------
55+
Installation
56+
------------
3557

36-
The latest release version of pytest-dependency is available on the
37-
`Python Package Index (PyPI)`__.
58+
.. _install-using-pip:
3859

39-
.. __: https://pypi.python.org/pypi/pytest_dependency/
60+
Installation using pip
61+
......................
4062

63+
You can install pytest-dependency from the `Python Package Index
64+
(PyPI)`__ using pip::
4165

42-
Installation
43-
------------
66+
$ pip install pytest-dependency
4467

45-
1. Download the sources, unpack, and change into the source directory.
68+
Note that while installing from PyPI is convenient, there is no way to
69+
verify the integrity of the source distribution, which may be
70+
considered a security risk.
4671

47-
2. Build (optional)::
72+
.. __: `PyPI site`_
73+
74+
Manual installation from the source distribution
75+
................................................
76+
77+
Release distributions are published on the GitHub. Steps to manually
78+
build from the source distribution:
79+
80+
1. Download the sources.
81+
82+
The `Release Page`__ offers download of the source distribution
83+
``pytest-dependency-X.X.tar.gz`` and a detached signature file
84+
``pytest-dependency-X.X.tar.gz.asc``, where the "X.X" is to be
85+
replaced by the version number.
86+
87+
2. Check the signature (optional).
88+
89+
You may verify the integrity of the source distribution by checking
90+
the signature::
91+
92+
$ gpg --verify pytest-dependency-0.5.1.tar.gz.asc
93+
gpg: assuming signed data in 'pytest-dependency-0.5.1.tar.gz'
94+
gpg: Signature made Fri Feb 14 21:58:30 2020 CET
95+
gpg: using RSA key B4EB920861DF33F31B55A07C08A1264175343E6E
96+
gpg: Good signature from "Rolf Krahl <[email protected]>" [ultimate]
97+
gpg: aka "Rolf Krahl <[email protected]>" [ultimate]
98+
gpg: aka "Rolf Krahl <[email protected]>" [ultimate]
99+
100+
The signature should be made by the key
101+
:download:`0xB4EB920861DF33F31B55A07C08A1264175343E6E
102+
<08A1264175343E6E.pub>`. The fingerprint of that key is::
103+
104+
B4EB 9208 61DF 33F3 1B55 A07C 08A1 2641 7534 3E6E
105+
106+
3. Unpack and change into the source directory.
107+
108+
4. Build (optional)::
48109

49110
$ python setup.py build
50111

51-
3. Test (optional)::
112+
5. Test (optional)::
52113

53-
$ python -m pytest tests
114+
$ python setup.py test
54115

55-
4. Install::
116+
6. Install::
56117

57118
$ python setup.py install
58119

59-
The last step might require admin privileges in order to write into
60-
the site-packages directory of your Python installation.
61-
62-
For production use, it is always recommended to use the latest release
63-
version from PyPI, see above.
120+
.. __: `GitHub latest release`_
64121

65122

66123
.. _setuptools: http://pypi.python.org/pypi/setuptools/
67124
.. _pytest: http://pytest.org/
125+
.. _git-props: https://github.com/RKrahl/git-props
126+
.. _distutils-pytest: https://github.com/RKrahl/distutils-pytest
68127
.. _pytest-order: https://github.com/pytest-dev/pytest-order
69128
.. _pytest-xdist: https://github.com/pytest-dev/pytest-xdist
129+
.. _PyPI site: https://pypi.python.org/pypi/pytest_dependency/
130+
.. _GitHub latest release: https://github.com/RKrahl/pytest-dependency/releases/latest

0 commit comments

Comments
 (0)