Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Commit e6f931c

Browse files
committed
chore: several improvements for setup and README files
1 parent 11b1332 commit e6f931c

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
# oidcmsg
2+
3+
![CI build](https://github.com/IdentityPython/oidcmsg/workflows/oidcmsg/badge.svg)
4+
![pypi](https://img.shields.io/pypi/v/oidcmsg.svg)
5+
[![Downloads](https://pepy.tech/badge/oidcmsg)](https://pepy.tech/project/oidcmsg)
6+
[![Downloads](https://pepy.tech/badge/oidcmsg/week)](https://pepy.tech/project/oidcmsg)
7+
![License](https://img.shields.io/badge/license-Apache%202-blue.svg)
8+
29
Implementation of OIDC protocol messages.
310

411
oidcmsg is the 2nd layer in the
@@ -10,17 +17,17 @@ It also does verification of messages , that is :
1017

1118
+ verifies that all the required parameters are present and has a value
1219
+ verifies that the parameter values are of the right type
13-
+ verifies that if there is a list of permitted values, a parameter value is on
20+
+ verifies that if there is a list of permitted values, a parameter value is on
1421
that list.
1522

1623
and finally if the value is a signed and/or encrypted JWT this package
17-
will perform the necessary decryption and signature verification.
24+
will perform the necessary decryption and signature verification.
1825

1926

20-
Also implements a **KeyJar** which keeps keys belonging to
27+
Also implements a **KeyJar** which keeps keys belonging to
2128
different owners. One owner may have many keys.
2229
If some of these keys have a common origin, like described in a JWKS.
2330
Such a set will be kept in a **keyBundle**.
24-
Also implemented in this package.
25-
31+
Also implemented in this package.
32+
2633
Please read the [Official Documentation](https://oidcmsg.readthedocs.io/) for getting usage examples and further informations.

setup.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,15 @@ def run_tests(self):
4343
version = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]',
4444
fd.read(), re.MULTILINE).group(1)
4545

46+
with open(os.path.join(os.path.dirname(__file__), 'README.md')) as readme:
47+
README = readme.read()
48+
4649
setup(
4750
name="oidcmsg",
4851
version=version,
4952
description="Python implementation of OAuth2 and OpenID Connect messages",
53+
long_description=README,
54+
long_description_content_type='text/markdown',
5055
author="Roland Hedberg",
5156
author_email="[email protected]",
5257
license="Apache 2.0",

0 commit comments

Comments
 (0)