Skip to content

Commit 73a92ef

Browse files
README.md,CONTRIBUTING.md: Remove references to the removed Python 2.7 tests
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
1 parent f76d406 commit 73a92ef

File tree

2 files changed

+7
-43
lines changed

2 files changed

+7
-43
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -164,44 +164,14 @@ Links:
164164
- <https://microsoft.github.io/pyright>
165165
- <https://google.github.io/pytype>
166166
167-
With `tox`, developers can run the full test suite for Python 2.7 and 3.x.
168-
The same test suite is used in GitHub CI:
167+
With `tox`, developers can run the full test suite with several Python versions.
168+
The same test suite is used in GitHub CI.
169+
To install the latest version of `tox`, in an activated Python `venv`, run:
169170
170171
```bash
171-
pip3 install --user --upgrade 'py>=1.11.0' 'virtualenv<20.22' 'tox==4.5.1'; hash -r; tox
172+
pip3 install --user --upgrade tox; hash -r; tox
172173
```
173174
174-
Explanation:
175-
176-
- `tox>=4` is needed in order to fix reading the python2.7 dependencies from `pyproject.toml`
177-
- `tox==4.5.1` is the last version not depending on `virtualenv>=20.23` (breaks Python 2.7)
178-
- The latest versions of `tox` need `'py>=1.11.0'`. This ensures that it is at least `1.11`.
179-
- `virtualenv-20.22` breaks using python2.7 for the `py27`, so has to be `virtualenv<20.22`.
180-
181-
## Installation of all development dependencies
182-
183-
Using pip-tools, you can extract the requirements and extras from `pyptoject.toml`:
184-
185-
```bash
186-
PYTHON=python3.10
187-
EXTRAS=.,test,mypy,pyright,pytype,tox
188-
PFLAGS="--no-warn-conflicts"
189-
$PYTHON -m pip install pip-tools==7.3.0
190-
$PYTHON -m piptools compile --extra=$EXTRAS -o - pyproject.toml |
191-
$PYTHON -m pip install -r /dev/stdin $PFLAGS
192-
```
193-
194-
With this, you can run most of the CI tests run by `tox` and GitHub CI also from the shell.
195-
196-
You can use e.g.: `tox -e py27-test -e py3.10-covcombine-check`
197-
The syntax is `-e py<python-version>-<factor1>[-factor2]`.
198-
A few of the factors are:
199-
200-
- `test`: runs `pytest`
201-
- `cov`: runs `pytest --cov` and generates `XML` and `HTML` reports in `.tox/py<ver>-cov/logs/`
202-
- `check`: runs `mypy`
203-
- `fox`: runs like `cov` but then opens the `HTML` reports in Firefox
204-
205175
## Recommended `tox` and `pytest` plugins for development
206176
207177
When updating existing tests or developing new code with new test coverage, we might want to
@@ -270,7 +240,7 @@ To run `podman` as your user, run these as your user:
270240
```bash
271241
systemctl enable --now --user podman.socket # Only configures the podman socket
272242
systemctl start --user podman.socket # Start the docker-compatible unix socket
273-
# Ubuntu only, Fedora 37 configures it already with more unqualifies search registries:
243+
# Ubuntu only, Fedora configures unqualified search registries out-of-the-box:
274244
echo 'unqualified-search-registries = ["docker.io"]' | sudo tee -a /etc/containers/registries.conf
275245
sudo touch /etc/containers/nodocker # Quiet the docker emulation notification
276246
echo "--container-daemon-socket unix://$XDG_RUNTIME_DIR/podman/podman.sock" >>~/.actrc

README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,6 @@ The package name is `python-libs` which is also the `rpm` package name in XenSer
1313
XCP-ng packages it as [xcp-python-libs](https://github.com/xcp-ng-rpms/xcp-python-libs)
1414
([koji](https://koji.xcp-ng.org/packageinfo?packageID=400)).
1515

16-
It supports Python 2.7 and is currently in progress to get further fixes for >= 3.6.
17-
It depends on `six`, and on Python 2.7, also `configparser` and `pyliblzma`.
18-
1916
## Test-driven Development (TDD) Model
2017

2118
Please see [CONTRIBUTING.md] for installing a local development environment.
@@ -25,11 +22,8 @@ Test-driven development.
2522

2623
The Continuous Integration Tests feature:
2724

28-
- Combined coverage testing of Python 2.7 and Python 3.8 code branches
29-
- Automatic Upload of the combined coverage to CodeCov (from the GitHub Workflow)
30-
- Checking of the combined coverage against the diff to master: Fails if changes are not covered!
31-
- Pylint report in the GitHub Action Summary page, with Warning and Error annotatios, even in the code review.
32-
- Check that changes don't generate pylint warnings (if warning classes which are enabled in .pylintrc)
25+
- `pylint` report in the GitHub Action Summary page with warning and error annotations in the code review.
26+
- Checks that changes don't generate `pylint` warnings
3327
- Static analysis using `mypy`, `pylint`, `pyright` and `pytype`
3428

3529
This enforces that any change (besides whitespace):

0 commit comments

Comments
 (0)