Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change minimum Python version to 3.10 #1172

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ version: 2
build:
os: ubuntu-22.04
tools:
python: "3.7"
python: "3.10"
jobs:
post_checkout:
- git fetch --unshallow || true
Expand Down
9 changes: 7 additions & 2 deletions doc/en/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ def generate_news():


def setup(app):
app.add_stylesheet("icon.css")
app.add_stylesheet("news.css")
try:
app.add_css_file("icon.css")
app.add_css_file("news.css")
except AttributeError:
app.add_stylesheet("icon.css")
app.add_stylesheet("news.css")

generate_news()
17 changes: 12 additions & 5 deletions doc/en/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,27 @@ in your local environment!
Supported Python Versions
=========================

Testplan is tested to work with Python 3.7 and 3.8, 3.10 and 3.11 so we recommend choosing one of those.
Testplan is tested to work with Python 3.10 and 3.11 so we recommend choosing one of those. Python 3.7 and 3.8 support is deprecated and will be removed soon.

.. _install_testplan:

Install testplan
================

Testplan is not yet available from pypi.org but one can still install it from the latest github package. A link for our lates package can be obtained from: https://github.com/morganstanley/testplan/releases/tag/latest
Testplan is available from pypi.org: https://pypi.org/project/testplan/

.. code-block:: bash

python3 -m pip install testplan


Alternatively, one can install it from the latest github package. A link for our lates package can be obtained from: https://github.com/morganstanley/testplan/releases/tag/latest

Install from archive:

.. code-block:: bash
zsambokiandras marked this conversation as resolved.
Show resolved Hide resolved

python3.7 -m pip install https://github.com/morganstanley/testplan/releases/download/latest/testplan-21.9.29-py3-none-any.whl
python3 -m pip install https://github.com/morganstanley/testplan/releases/download/24.9.2/testplan-24.9.2-py3-none-any.whl


Run testplan
Expand Down Expand Up @@ -76,8 +83,8 @@ Also find all our downloadable examples :ref:`here <download>`.

Working with the source
-----------------------

You will need a working python 3.7+ interrpreter preferably a venv, and for the interactive ui you need node installed.
You will need a working Python 3 interpreter preferably a venv, and for the interactive ui you need Node.js installed.
We are using `doit <https://pydoit.org/contents.html>`_ as the taskrunner ``doit list`` can show all the commands.

.. code-block:: text
Expand Down
5 changes: 5 additions & 0 deletions doc/en/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
.. attention::

Support for Python 3.7 and 3.8 is deprecated and will be removed soon.
Please upgrade to newer versions.

.. raw:: html

<div style="font-size:80px;font-family:Arial;font-weight:bold;">
Expand Down
2 changes: 1 addition & 1 deletion doc/en/unittests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Python - unittest
=================

``unittest`` is the unit-testing framework built into the Python standard library,
see https://docs.python.org/3.7/library/unittest.html for more information.
see https://docs.python.org/3/library/unittest.html for more information.
``unittest`` testcases may be integrated with Testplan via the :py:class:`~testplan.testing.pyunit.PyUnit`
test runner. Example can be found :ref:`here <example_pyunit>`.

Expand Down
1 change: 1 addition & 0 deletions doc/newsfragments/3055_deprecated.py37_38_deprecated.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Support for Python 3.7 and 3.8 is deprecated and will be removed soon.
2 changes: 1 addition & 1 deletion examples/Multitest/Parallel/parallel_tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ def __init__(self):
#
# Note that on Python 3 you can use the Barrier class from the standard
# library:
# https://docs.python.org/3.7/library/threading.html#barrier-objects .
# https://docs.python.org/3/library/threading.html#barrier-objects .
# Here we use a backported Barrier provided by Testplan, which works
# on both Python 2 and 3.
self._barrier = thread_utils.Barrier(2)
Expand Down
4 changes: 2 additions & 2 deletions examples/PyUnit/test_plan.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class TestAlpha(unittest.TestCase):
"""
Minimal PyUnit testcase with a single trivial test method. For more
information about the unittest library, see the [documentation](
http://docs.python.org/2/library/unittest.html).
http://docs.python.org/3/library/unittest.html).
"""

def test_example(self):
Expand All @@ -42,7 +42,7 @@ class TestBeta(unittest.TestCase):
"""
Minimal PyUnit testcase with a single trivial test method. For more
information about the unittest library, see the [documentation](
http://docs.python.org/2/library/unittest.html).
http://docs.python.org/3/library/unittest.html).
"""

def test_fails(self):
Expand Down
2 changes: 1 addition & 1 deletion testplan/testing/filtering.py
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ class Pattern(Filter):
"""
Base class for name based, glob style filtering.

https://docs.python.org/3.4/library/fnmatch.html
https://docs.python.org/3/library/fnmatch.html

Examples:

Expand Down
2 changes: 1 addition & 1 deletion tests/unit/testplan/testing/test_pyunit.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class Passing(unittest.TestCase):
"""
Minimal PyUnit testcase with a single trivial test method. For more
information about the unittest library, see the [documentation](
http://docs.python.org/2/library/unittest.html).
http://docs.python.org/3/library/unittest.html).
"""

def test_asserts(self):
Expand Down
Loading