Change .rst to .md.
This commit is contained in:
parent
6646bdb92a
commit
7cef7ab11a
4 changed files with 30 additions and 57 deletions
27
README.md
Normal file
27
README.md
Normal file
|
@ -0,0 +1,27 @@
|
||||||
|
# Django OIDC Provider
|
||||||
|
|
||||||
|
[![PyPI](https://img.shields.io/pypi/pyversions/django-oidc-provider.svg)]()
|
||||||
|
[![PyPI](https://img.shields.io/pypi/v/django-oidc-provider.svg)]()
|
||||||
|
[![PyPI](https://travis-ci.org/juanifioren/django-oidc-provider.svg?branch=master)]()
|
||||||
|
[![PyPI](https://img.shields.io/pypi/dm/django-oidc-provider.svg)]()
|
||||||
|
|
||||||
|
## About OpenID
|
||||||
|
|
||||||
|
OpenID Connect is a simple identity layer on top of the OAuth 2.0 protocol, which allows computing clients to verify the identity of an end-user based on the authentication performed by an authorization server, as well as to obtain basic profile information about the end-user in an interoperable and REST-like manner. Like [Google](https://developers.google.com/identity/protocols/OpenIDConnect) for example.
|
||||||
|
|
||||||
|
## About the package
|
||||||
|
|
||||||
|
`django-oidc-provider` can help you providing out of the box all the endpoints, data and logic needed to add OpenID Connect capabilities to your Django projects.
|
||||||
|
|
||||||
|
Support for Python 3 and 2. Also latest versions of django.
|
||||||
|
|
||||||
|
[Read docs for more info](https://github.com/juanifioren/django-oidc-provider/blob/v0.2.x/DOC.md) or [see the changelog here](https://github.com/juanifioren/django-oidc-provider/blob/v0.2.x/CHANGELOG.md).
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
We love contributions, so please feel free to fix bugs, improve things, provide documentation. You SHOULD follow this steps:
|
||||||
|
|
||||||
|
* Fork the project.
|
||||||
|
* Make your feature addition or bug fix.
|
||||||
|
* Add tests for it inside `oidc_provider/tests`. Then run all and ensure everything is OK (read docs for how to test in all envs).
|
||||||
|
* Send pull request to the specific version branch.
|
54
README.rst
54
README.rst
|
@ -1,54 +0,0 @@
|
||||||
|
|
||||||
Django OIDC Provider
|
|
||||||
####################
|
|
||||||
.. image:: https://img.shields.io/pypi/pyversions/django-oidc-provider.svg
|
|
||||||
:target: https://pypi.python.org/pypi/django-oidc-provider
|
|
||||||
|
|
||||||
.. image:: https://img.shields.io/pypi/v/django-oidc-provider.svg
|
|
||||||
:target: https://pypi.python.org/pypi/django-oidc-provider
|
|
||||||
|
|
||||||
.. image:: https://travis-ci.org/juanifioren/django-oidc-provider.svg?branch=master
|
|
||||||
:target: http://travis-ci.org/juanifioren/django-oidc-provider
|
|
||||||
|
|
||||||
.. image:: https://img.shields.io/pypi/dm/django-oidc-provider.svg
|
|
||||||
:target: https://pypi.python.org/pypi/django-oidc-provider
|
|
||||||
|
|
||||||
************
|
|
||||||
About OpenID
|
|
||||||
************
|
|
||||||
|
|
||||||
OpenID Connect is a simple identity layer on top of the OAuth 2.0 protocol, which allows computing clients to verify the identity of an end-user based on the authentication performed by an authorization server, as well as to obtain basic profile information about the end-user in an interoperable and REST-like manner. `Google <https://developers.google.com/identity/protocols/OpenIDConnect>`_ is a good example of an OpenID Provider.
|
|
||||||
|
|
||||||
*****************
|
|
||||||
About the package
|
|
||||||
*****************
|
|
||||||
|
|
||||||
Django OIDC Provider can help you providing out of the box all the endpoints, data and logic needed to add OpenID Connect capabilities to your Django projects.
|
|
||||||
|
|
||||||
Support for Python 3 and 2. Also latest versions of django.
|
|
||||||
|
|
||||||
Read docs for more info.
|
|
||||||
|
|
||||||
https://github.com/juanifioren/django-oidc-provider/blob/v0.2.x/DOC.md
|
|
||||||
|
|
||||||
See changelog here.
|
|
||||||
|
|
||||||
https://github.com/juanifioren/django-oidc-provider/blob/v0.2.x/CHANGELOG.md
|
|
||||||
|
|
||||||
****************
|
|
||||||
Examples running
|
|
||||||
****************
|
|
||||||
|
|
||||||
* **BAID** by Government of Buenos Aires City. (`view site <https://id.buenosaires.gob.ar/>`_)
|
|
||||||
* **Example OIDC provider** by Juan Ignacio Fiorentino. (`view site <http://openid.juanifioren.com/>`_)
|
|
||||||
|
|
||||||
************
|
|
||||||
Contributing
|
|
||||||
************
|
|
||||||
|
|
||||||
We love contributions, so please feel free to fix bugs, improve things, provide documentation. You SHOULD follow this steps:
|
|
||||||
|
|
||||||
* Fork the project.
|
|
||||||
* Make your feature addition or bug fix.
|
|
||||||
* Add tests for it inside :code:`oidc_provider/tests`. Then run all and ensure everything is OK (read docs for how to test in all envs).
|
|
||||||
* Send pull request to the specific version branch.
|
|
|
@ -1,5 +1,7 @@
|
||||||
# Example Project
|
# Example Project
|
||||||
|
|
||||||
|
![Example Project](http://s12.postimg.org/e4uwlsi0d/Screenshot_from_2016_02_02_13_15_26.png)
|
||||||
|
|
||||||
Run your own OIDC provider in a second. This is a Django app with all the necessary things to work with `django-oidc-provider` package.
|
Run your own OIDC provider in a second. This is a Django app with all the necessary things to work with `django-oidc-provider` package.
|
||||||
|
|
||||||
## Setup & Running
|
## Setup & Running
|
||||||
|
|
4
setup.py
4
setup.py
|
@ -1,8 +1,6 @@
|
||||||
import os
|
import os
|
||||||
from setuptools import setup
|
from setuptools import setup
|
||||||
|
|
||||||
with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as readme:
|
|
||||||
README = readme.read()
|
|
||||||
|
|
||||||
# allow setup.py to be run from any path
|
# allow setup.py to be run from any path
|
||||||
os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
|
os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
|
||||||
|
@ -18,7 +16,7 @@ setup(
|
||||||
include_package_data=True,
|
include_package_data=True,
|
||||||
license='MIT License',
|
license='MIT License',
|
||||||
description='OpenID Connect Provider implementation for Django.',
|
description='OpenID Connect Provider implementation for Django.',
|
||||||
long_description=README,
|
long_description='http://github.com/juanifioren/django-oidc-provider',
|
||||||
url='http://github.com/juanifioren/django-oidc-provider',
|
url='http://github.com/juanifioren/django-oidc-provider',
|
||||||
author='Juan Ignacio Fiorentino',
|
author='Juan Ignacio Fiorentino',
|
||||||
author_email='juanifioren@gmail.com',
|
author_email='juanifioren@gmail.com',
|
||||||
|
|
Loading…
Reference in a new issue