lvkm/pyrad3
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

fix some rst

Browse Source
This commit is contained in:
Istvan Ruzman
2020-09-06 20:58:00 +02:00
parent ae868a6976
commit 2b5e7ceeed
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.rst
View File

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