Skip to content

Commit

Permalink
docs: updates to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nedbat committed Oct 31, 2022
1 parent 1bf107c commit 5330a94
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 16 deletions.
25 changes: 15 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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::

Expand Down
13 changes: 7 additions & 6 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,18 +49,19 @@ 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(
name='django_coverage_plugin',
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',
Expand All @@ -71,6 +72,6 @@ def read(*names, **kwargs):
'coverage',
'six >= 1.4.0',
],
license='Apache 2.0',
license='Apache-2.0',
classifiers=classifiers.splitlines(),
)

0 comments on commit 5330a94

Please sign in to comment.