Add Python 3.10 to CI builds

- minor documentation updates

Author: mrbean-bremen

.github/workflows/pythontests.yml

@@ -40,7 +40,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python-version: [2.7, 3.5, 3.6, 3.7, 3.8, 3.9, pypy2, pypy3]
+        python-version: [2.7, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10-dev, pypy2, pypy3]
         exclude:
           - os: windows-latest
             python-version: pypy2
@@ -70,7 +70,7 @@ jobs:
         python -m pip install pytest pytest-cov tox
     - name: Run tests
       run: |
-        TOX_PYTHON_VERSION=$(if [ ${{ matrix.python-version }} = pypy2 ]; then echo "pypy2"; elif [ ${{ matrix.python-version }} = pypy3 ]; then echo "pypy3"; else echo py${{ matrix.python-version }} | tr -d .; fi)
+        TOX_PYTHON_VERSION=$(if [ ${{ matrix.python-version }} = pypy2 ]; then echo "pypy2"; elif [ ${{ matrix.python-version }} = pypy3 ]; then echo "pypy3"; else echo py${{ matrix.python-version }} | tr -d .-; fi)
         COV_CMD=$(if [ ${{ matrix.python-version }} = 3.8 ]; then echo "--cov=./pytest_order/ --cov-report=xml"; else echo ; fi) tox -e $(tox -l | grep $TOX_PYTHON_VERSION | paste -sd "," -)
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v1

README.md

@@ -12,8 +12,8 @@ test shall be run relative to the other tests.
 some additional features - see [below](#comparison-with-pytest_ordering) for
 details.
 
-`pytest-order` works with Python 2.7 and 3.5 - 3.9, with pytest 
-versions >= 3.7.0, and runs on Linux, MacOs and Windows.
+`pytest-order` works with Python 2.7 and 3.5 - 3.10, with pytest 
+versions >= 3.7.0, and runs on Linux, macOS and Windows.
 
 Documentation
 -------------
@@ -88,6 +88,17 @@ Features
 A usage guide for each feature can be
 found in the [documentation](https://pytest-dev.github.io/pytest-order/dev/).
 
+Contributing
+------------
+Contributions are very welcome. Tests can be run with 
+[tox](https://tox.readthedocs.io/en/latest/), please ensure
+the coverage at least stays the same before you submit a pull request.
+
+License
+-------
+Distributed under the terms of the [MIT](http://opensource.org/licenses/MIT)
+license, `pytest-order` is free and open source software.
+
 History
 -------
 This is a fork of [pytest-ordering](https://github.com/ftobia/pytest-ordering).
@@ -104,7 +115,7 @@ with `pytest-ordering` due to the changed marker name (`order` instead of
 rationale see also
 [this issue](https://github.com/ftobia/pytest-ordering/issues/38)).
 
-Ordering relative to other tests and all of the configuration options are not
+Ordering relative to other tests and all the configuration options are not
 available in the released version of `pytest-ordering`.
 However, most of these features are derived from 
 [issues](https://github.com/pytest-dev/pytest-order/blob/main/old_issues.md)

docs/source/index.rst

@@ -38,7 +38,7 @@ ordering, all configuration options) that are not available in
 
 Supported Python and pytest versions
 ------------------------------------
-``pytest-order`` supports python 2.7, 3.5 - 3.9, and pypy/pypy3, and is
+``pytest-order`` supports python 2.7, 3.5 - 3.10, and pypy/pypy3, and is
 compatible with pytest 3.7.0 or newer. Note that support for Python 2 will
 be removed in one of the next versions.
 
@@ -460,7 +460,7 @@ regardless of the ordinal markers.
 Several relationships for the same marker
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 If you need to order a certain test relative to more than one other test, you
-can add more than one test name to the ``before`` or ``after marker
+can add more than one test name to the ``before`` or ``after`` marker
 attributes, separated by spaces:
 
 .. code:: python
@@ -1016,7 +1016,7 @@ Using pytest-order with other pytest plugins
 
 Relationship with pytest-dependency
 -----------------------------------
-The `pytest-dependency <https://pypi.org/project/pytest-dependency/>`__
+The `pytest-dependency`_
 plugin also manages dependencies between tests (skips tests that depend
 on skipped or failed tests), but currently doesn't do any ordering. If you
 want to execute the tests in a specific order to each other, you can use
@@ -1025,11 +1025,11 @@ tests you can use ``pytest-dependency``. If you want to have both behaviors
 combined, you can use both plugins together with the
 option :ref:`order-dependencies`, described above.
 
-Using together with pytest-randomly
------------------------------------
+Usage with other ordering plugins
+---------------------------------
 There is a number of other pytest plugins that change the order in which tests
 are executed, the most widely known probably being
-`pytest-randomly <https://pypi.org/project/pytest-randomly/>`__, which
+`pytest-randomly`_, which
 executes tests in a random order to avoid unknown test dependencies.
 ``pytest-order`` should still work with these as long as it is executed
 *after* the other plugins (which it should by default, except if you use
@@ -1080,10 +1080,17 @@ The same is true for relative ordering. The tests will be correctly ordered
 before and after the tests as configured, but all other tests will be in an
 arbitrary order.
 
+Note that it does not make much sense to use ordering plugins together that
+have a similar goal as ``pytest-order``, as for example ``pytest-ordering``.
+As mentioned, both plugins can co-exist without problems due to the
+different marker names, but using markers of both plugins in the same test
+run is not recommended. One plugin may partially revert the effects of the
+other plugin in unpredictable ways. The same is true for other plugins that
+define the test order.
 
 Usage with pytest-xdist
 -----------------------
-The `pytest-xdist <https://pypi.org/project/pytest-xdist/>`__ plugin
+The `pytest-xdist`_ plugin
 schedules tests unordered, and the order configured by ``pytest-order``
 will normally not be preserved. But if we use the ``--dist=loadfile``
 option, provided by ``xdist``, all tests from one file will be run in the
@@ -1094,3 +1101,8 @@ each group of dependent tests in one file, and call pytest with
 
 .. toctree::
    :maxdepth: 2
+
+
+.. _`pytest-xdist`: https://pypi.org/project/pytest-xdist/
+.. _`pytest-randomly`: https://pypi.org/project/pytest-randomly/
+.. _`pytest-dependency`: https://pypi.org/project/pytest-dependency/

setup.py

@@ -47,6 +47,7 @@
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: Implementation :: CPython",
         "Programming Language :: Python :: Implementation :: PyPy",
     ],

tox.ini

@@ -1,9 +1,9 @@
 # content of: tox.ini, put in same dir as setup.py
 [tox]
 envlist =
-    {py27,py35,py36,py37,py38,py39,pypy2,pypy3}-pytest{37,38,39,310,40,41,42,43,44,45,46}
-    {py35,py36,py37,py38,py39,pypy3}-pytest{50,51,52,53,54,60,61}
-    {py36,py37,py38,py39,pypy3}-pytest62
+    {py27,py35,py36,py37,py38,py39,py310dev,pypy2,pypy3}-pytest{37,38,39,310,40,41,42,43,44,45,46}
+    {py35,py36,py37,py38,py39,py310dev,pypy3}-pytest{50,51,52,53,54,60,61}
+    {py36,py37,py38,py39,py310,pypy3}-pytest62
 [testenv]
 deps =
     pytest37: pytest>=3.7,<3.8