From 5330a9489d6bebf2910f1c26ab19b37bbabbbfe7 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Mon, 31 Oct 2022 06:37:32 -0400 Subject: [PATCH] docs: updates to the readme --- README.rst | 25 +++++++++++++++---------- setup.py | 13 +++++++------ 2 files changed, 22 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index e7c7541..e96fa9e 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,13 @@ +================================== +Django Template Coverage.py Plugin +================================== + +A `coverage.py`_ plugin to measure test coverage of Django templates. + .. start-badges -|status| |kit| |license| |versions| |djversions| +| |status| |kit| |license| +| |versions| |djversions| .. |status| image:: https://img.shields.io/pypi/status/django_coverage_plugin.svg :target: https://pypi.python.org/pypi/django_coverage_plugin @@ -14,23 +21,21 @@ .. |versions| image:: https://img.shields.io/pypi/pyversions/django_coverage_plugin.svg :target: https://pypi.python.org/pypi/django_coverage_plugin :alt: Supported Python Versions -.. |djversions| image:: https://img.shields.io/badge/Django-1.8%20%7C%201.11%20%7C%202.0%20%7C%202.1%20%7C%202.2%20%7C%203.0-44b78b.svg +.. |djversions| image:: https://img.shields.io/badge/Django-1.8%20%7C%201.11%20%7C%202.2%20%7C%203.2%20%7C%204.1-44b78b.svg :target: https://pypi.python.org/pypi/django_coverage_plugin :alt: Supported Django Versions -.. end-badges +------------------ -================================== -Django Template Coverage.py Plugin -================================== +.. end-badges -A `coverage.py`_ plugin to measure test coverage of Django templates. +Supported on: -Supported Python versions: 2.7, and 3.6 through 3.10. +- Python: 2.7, and 3.6 through 3.11. -Supported Django versions: 1.8, 1.11, 2.x, 3.x and 4.x. +- Django: 1.8, 1.11, 2.x, 3.x and 4.x. -Supported coverage.py versions: 4.x or higher. +- Coverage.py: 4.x or higher. The plugin is pip installable:: diff --git a/setup.py b/setup.py index 2f9f548..e4cea78 100644 --- a/setup.py +++ b/setup.py @@ -49,7 +49,7 @@ def read(*names, **kwargs): Framework :: Django :: 1.11 Framework :: Django :: 2.2 Framework :: Django :: 3.2 -Framework :: Django :: 4.0 +Framework :: Django :: 4.1 """ setup( @@ -57,10 +57,11 @@ def read(*names, **kwargs): version='2.0.3', description='Django template coverage.py plugin', long_description=( - re.compile( - '^.. start-badges.*^.. end-badges', - re.M | re.S, - ).sub('', read('README.rst')) + re.sub( + '(?ms)^.. start-badges.*^.. end-badges', + '', + read('README.rst'), + ) ), long_description_content_type='text/x-rst', author='Ned Batchelder', @@ -71,6 +72,6 @@ def read(*names, **kwargs): 'coverage', 'six >= 1.4.0', ], - license='Apache 2.0', + license='Apache-2.0', classifiers=classifiers.splitlines(), )