@@ -33,23 +33,19 @@ you frustration.
33
33
Getting the code
34
34
----------------
35
35
36
- Fork the repo into your own github repository. If you have not forked a
37
- repository before then please follow the ` fork instructions `_ provided by
38
- github.
36
+ The coverage.py code is hosted on a GitHub repository at
37
+ https://github.com/nedbat/coveragepy. To get a working environment, follow
38
+ these steps:
39
39
40
- .. _fork instructions : https://docs.github.com/en/get-started/quickstart/fork-a-repo
40
+ #. `Fork the repo `__ into your own GitHub account. The coverage.py code
41
+ will then be copied into a GitHub repository at
42
+ https://github.com/GITHUB_USER/coveragepy where GITHUB_USER is your GitHub
43
+ username.
41
44
42
- The coverage.py code will then be copied into a GitHub repository at
43
- https://github.com/GITHUB_USER/coveragepy where GITHUB_USER is your github
44
- username. To get a working development environment, follow these steps:
45
-
46
- .. minimum of PYVERSIONS:
47
-
48
- #. Create a virtualenv using one of the common virtualenv formats (conda,
49
- venv, pipenv, etc) and a version of python greater than 3.7 to work in, and
50
- activate it. Please follow your virtualenv format specific creation and
51
- activation instructions.
45
+ __ https://docs.github.com/en/get-started/quickstart/fork-a-repo
52
46
47
+ #. (Optional) Create a virtualenv to work in, and activate it. There
48
+ are a number of ways to do this. Use the method you are comfortable with.
53
49
54
50
#. Clone the repository::
55
51
@@ -58,27 +54,16 @@ activation instructions.
58
54
59
55
#. Install the requirements::
60
56
61
- $ python3 -m pip install -r requirements/dev.pip
62
-
63
- If this fails due to incorrect or missing hashes, use
64
- ``dev.in`` instead::
65
-
66
57
$ python3 -m pip install -r requirements/dev.in
67
-
68
- Note: You may need to upgrade pip to install the requirements.
69
58
70
- #. (Optional) Install more versions of Python. By default, Coverage.py won't
71
- run the tests on a version of python that isn't installed. Coverage.py
72
- supports a range of Python versions. The more you can test with, the more
73
- easily your code can be used as-is. If you only have one version, that's
74
- OK too, but may mean more work integrating your contribution.
59
+ Note: You may need to upgrade pip to install the requirements.
75
60
76
61
77
62
Running the tests
78
63
-----------------
79
64
80
65
The tests are written mostly as standard unittest-style tests, and are run with
81
- pytest running under `tox `_ by using the command ` python3 -m tox ` ::
66
+ pytest running under `tox `_::
82
67
83
68
% python3 -m tox
84
69
ROOT: tox-gh won't override envlist because tox is not running in GitHub Actions
0 commit comments