diff --git a/README.rst b/README.rst index 21bc656..25160e5 100644 --- a/README.rst +++ b/README.rst @@ -4,9 +4,9 @@ :target: https://coveralls.io/github/pyradius/pyrad3?branch=master .. image:: https://img.shields.io/pypi/v/pyrad3.svg :target: https://pypi.python.org/pypi/pyrad3 -.. image:: https://img.shields.io/pypi/pyversions/pyrad.svg +.. image:: https://img.shields.io/pypi/pyversions/pyrad3.svg :target: https://pypi.python.org/pypi/pyrad3 -.. image:: https://img.shields.io/pypi/dm/pyrad.svg +.. image:: https://img.shields.io/pypi/dm/pyrad3.svg :target: https://pypi.python.org/pypi/pyrad3 Introduction @@ -20,10 +20,12 @@ This is the successor of pyrad. It is written in python3 only (python3.7+) and has an improved API. Requirements & Installation -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ pyrad requires Python 3.7 or later. Currently no external dependencies are -needed to use pyrad3:: cli +needed to use pyrad3: + +.. code-block:: cli # Install from pypi pip install pyrad3 @@ -38,7 +40,7 @@ needed to use pyrad3:: cli poetry install # for development Development -=========== +~~~~~~~~~~~ pyrad3 usese quite a lot of linters and development tools: @@ -46,12 +48,14 @@ pyrad3 usese quite a lot of linters and development tools: - black - poetry - pytest + - pytest-black - pytest-cov - pytest-flake8 - pytest-isort - pytest-mypy - pytest-pylint + - tox - sphinx @@ -89,7 +93,7 @@ To execute a test with a single python version run `tox -e $version`, e.g. `tox -e py38`. License -======= +~~~~~~~ pyrad3 is distributed under the terms of both the MIT License and the Apache License (Version 2.0).