.. image:: https://ci.appveyor.com/api/projects/status/5g3ucux767mef3f4/branch/master?svg=true
:target: https://ci.appveyor.com/project/tpazderka/pyoidc/branch/master
.. image:: https://img.shields.io/pypi/pyversions/oic.svg
:target: https://pypi.python.org/pypi/oic
.. image:: https://img.shields.io/pypi/v/oic.svg
:target: https://pypi.python.org/pypi/oic
.. image:: https://readthedocs.org/projects/pyoidc/badge/?version=latest
:target: http://pyoidc.readthedocs.io/en/latest/?badge=latest
.. image:: https://codecov.io/gh/CZ-NIC/pyoidc/branch/master/graph/badge.svg
:target: https://codecov.io/gh/CZ-NIC/pyoidc
.. image:: https://api.codacy.com/project/badge/Grade/2038cfa7c56b480db6ae18b8320d7157
:target: https://www.codacy.com/app/tpazderka/pyoidc?utm_source=github.com&utm_medium=referral&utm_content=CZ-NIC/pyoidc&utm_campaign=Badge_Grade
A Python OpenID Connect implementation
======================================
This is a complete implementation of OpenID Connect as specified in the `OpenID
Connect Core specification`_. And as a side effect, a complete implementation
of OAuth2.0 too.
Please see the `CHANGELOG.md`_ to review the latest changes.
.. _OpenID Connect Core specification: http://openid.net/specs/openid-connect-core-1_0.html
.. _CHANGELOG.md: https://github.com/CZ-NIC/pyoidc/blob/master/CHANGELOG.md
Documentation
==============
The `documentation`_ is graciously hosted by `Read the Docs`_. Unfortunately,
the documentation has been largely left unmaintained and `there are various
issues`_. However, the maintainers are trying to remedy this lately with some
new momentum. Please help us by submitting pull requests if you can help
improve the documentation.
.. _documentation: http://pyoidc.rtfd.io
.. _Read the Docs: https://readthedocs.org/
.. _there are various issues: https://github.com/CZ-NIC/pyoidc/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation
Examples
========
Unfortunately, the current examples included in this repository are
unmaintained and `there are many issues`_. We're currently in the process of
creating a working canonical example implementation, however, until that time,
the current examples largely do not work. Please help us by submitting pull
requests that may bring these examples back into a working condition if you
get something working locally.
.. _there are many issues: https://github.com/CZ-NIC/pyoidc/issues?q=is%3Aopen+is%3Aissue+label%3Aexamples
Acknowledgements
================
Cudos to Vladislav Mladenov and Christian Mainka both at
Horst Görtz Institute for IT-Security, Ruhr-University Bochum, Germany
for helping me making the implementation more secure.
Maintainers Needed
==================
If you're interested in helping maintain and improve this package, we're
looking for you! We're working on the project on a best effort basis but we
still maintain a good flow of reviewing each others pull requests and driving
discussions on what should be done.
Please contact one of the current maintainers `@rohe`_, `@tpazderka`_ or `@schlenk`_.
.. _@rohe: https://github.com/rohe/
.. _@tpazderka: https://github.com/tpazderka/
.. _@schlenk: https://github.com/schlenk
Contribute
==========
`Fork the repository`_, clone your copy and `install pipenv`_.
.. _Fork the repository: https://github.com/CZ-NIC/pyoidc#fork-destination-box
.. _install pipenv: https://pipenv.readthedocs.io/en/latest/
Then just run:
.. code:: bash
$ make install
Next, running the tests:
.. code:: bash
$ make test
This will not affect your system level Python installation. Please review `our
issues`_ to see what needs working on. Do not hesitate to ask questions if
something is unclear. We mark easy issues as `newcomer-friendly`_, so they are
a good place to start if you want to contribute.
.. _our issues: https://github.com/CZ-NIC/pyoidc/issues
.. _newcomer-friendly: https://github.com/CZ-NIC/pyoidc/issues?q=is%3Aopen+is%3Aissue+label%3Anewcomer-friendly
Windows
-------
If you happen to work in a Windows environment, the above will not work out of the box due to the lack
of a ``GNU Make`` on Windows. In addition one of the dependencies for ``ldap_authn`` is not available as a prebuilt
wheel from pypi, so use these slightly modified instructions.
With :code:`pipenv` in your path you run:
.. code:: console
pipenv install --dev -e .[develop,testing,docs,quality]
Next you can run the tests:
.. code:: console
pipenv run pytest tests
Raw data
{
"_id": null,
"home_page": "https://github.com/CZ-NIC/pyoidc/",
"name": "oic",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Roland Hedberg",
"author_email": "roland@catalogix.se",
"download_url": "https://files.pythonhosted.org/packages/93/cf/5cffb5e6a0f28c6ebd7114741b35e3a11528c759944c048b27c0722e7585/oic-1.6.1.tar.gz",
"platform": null,
"description": ".. image:: https://ci.appveyor.com/api/projects/status/5g3ucux767mef3f4/branch/master?svg=true\n :target: https://ci.appveyor.com/project/tpazderka/pyoidc/branch/master\n\n.. image:: https://img.shields.io/pypi/pyversions/oic.svg\n :target: https://pypi.python.org/pypi/oic\n\n.. image:: https://img.shields.io/pypi/v/oic.svg\n :target: https://pypi.python.org/pypi/oic\n\n.. image:: https://readthedocs.org/projects/pyoidc/badge/?version=latest\n :target: http://pyoidc.readthedocs.io/en/latest/?badge=latest\n\n.. image:: https://codecov.io/gh/CZ-NIC/pyoidc/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/CZ-NIC/pyoidc\n\n.. image:: https://api.codacy.com/project/badge/Grade/2038cfa7c56b480db6ae18b8320d7157\n :target: https://www.codacy.com/app/tpazderka/pyoidc?utm_source=github.com&utm_medium=referral&utm_content=CZ-NIC/pyoidc&utm_campaign=Badge_Grade\n\nA Python OpenID Connect implementation\n======================================\n\nThis is a complete implementation of OpenID Connect as specified in the `OpenID\nConnect Core specification`_. And as a side effect, a complete implementation\nof OAuth2.0 too.\n\nPlease see the `CHANGELOG.md`_ to review the latest changes.\n\n.. _OpenID Connect Core specification: http://openid.net/specs/openid-connect-core-1_0.html\n.. _CHANGELOG.md: https://github.com/CZ-NIC/pyoidc/blob/master/CHANGELOG.md\n\nDocumentation\n==============\n\nThe `documentation`_ is graciously hosted by `Read the Docs`_. Unfortunately,\nthe documentation has been largely left unmaintained and `there are various\nissues`_. However, the maintainers are trying to remedy this lately with some\nnew momentum. Please help us by submitting pull requests if you can help\nimprove the documentation.\n\n.. _documentation: http://pyoidc.rtfd.io\n.. _Read the Docs: https://readthedocs.org/\n.. _there are various issues: https://github.com/CZ-NIC/pyoidc/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation\n\nExamples\n========\n\nUnfortunately, the current examples included in this repository are\nunmaintained and `there are many issues`_. We're currently in the process of\ncreating a working canonical example implementation, however, until that time,\nthe current examples largely do not work. Please help us by submitting pull\nrequests that may bring these examples back into a working condition if you\nget something working locally.\n\n.. _there are many issues: https://github.com/CZ-NIC/pyoidc/issues?q=is%3Aopen+is%3Aissue+label%3Aexamples\n\nAcknowledgements\n================\n\nCudos to Vladislav Mladenov and Christian Mainka both at\nHorst G\u00f6rtz Institute for IT-Security, Ruhr-University Bochum, Germany\nfor helping me making the implementation more secure.\n\nMaintainers Needed\n==================\n\nIf you're interested in helping maintain and improve this package, we're\nlooking for you! We're working on the project on a best effort basis but we\nstill maintain a good flow of reviewing each others pull requests and driving\ndiscussions on what should be done.\n\nPlease contact one of the current maintainers `@rohe`_, `@tpazderka`_ or `@schlenk`_.\n\n.. _@rohe: https://github.com/rohe/\n.. _@tpazderka: https://github.com/tpazderka/\n.. _@schlenk: https://github.com/schlenk\n\nContribute\n==========\n\n`Fork the repository`_, clone your copy and `install pipenv`_.\n\n.. _Fork the repository: https://github.com/CZ-NIC/pyoidc#fork-destination-box\n.. _install pipenv: https://pipenv.readthedocs.io/en/latest/\n\nThen just run:\n\n.. code:: bash\n\n $ make install\n\nNext, running the tests:\n\n.. code:: bash\n\n $ make test\n\nThis will not affect your system level Python installation. Please review `our\nissues`_ to see what needs working on. Do not hesitate to ask questions if\nsomething is unclear. We mark easy issues as `newcomer-friendly`_, so they are\na good place to start if you want to contribute.\n\n.. _our issues: https://github.com/CZ-NIC/pyoidc/issues\n.. _newcomer-friendly: https://github.com/CZ-NIC/pyoidc/issues?q=is%3Aopen+is%3Aissue+label%3Anewcomer-friendly\n\nWindows\n-------\n\nIf you happen to work in a Windows environment, the above will not work out of the box due to the lack\nof a ``GNU Make`` on Windows. In addition one of the dependencies for ``ldap_authn`` is not available as a prebuilt\nwheel from pypi, so use these slightly modified instructions.\n\nWith :code:`pipenv` in your path you run:\n\n.. code:: console\n\n pipenv install --dev -e .[develop,testing,docs,quality]\n\nNext you can run the tests:\n\n.. code:: console\n\n pipenv run pytest tests\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Python implementation of OAuth2 and OpenID Connect",
"version": "1.6.1",
"project_urls": {
"Homepage": "https://github.com/CZ-NIC/pyoidc/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "795e199e76afb5246bdedf8f4eea0a86ee5e95215d7632c1b69d7d6a431b7556",
"md5": "cc82807eae1b529ee8733659ac11ea71",
"sha256": "fcbf948a22e4d4df66f6bf57d327933f32a7b539640d9b42883457634360ba78"
},
"downloads": -1,
"filename": "oic-1.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cc82807eae1b529ee8733659ac11ea71",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 192365,
"upload_time": "2023-07-03T07:09:01",
"upload_time_iso_8601": "2023-07-03T07:09:01.103462Z",
"url": "https://files.pythonhosted.org/packages/79/5e/199e76afb5246bdedf8f4eea0a86ee5e95215d7632c1b69d7d6a431b7556/oic-1.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "93cf5cffb5e6a0f28c6ebd7114741b35e3a11528c759944c048b27c0722e7585",
"md5": "64502035641f2266c2afb35c24292130",
"sha256": "385a1f64bb59519df1e23840530921bf416740240f505ea6d161e331d3d39fad"
},
"downloads": -1,
"filename": "oic-1.6.1.tar.gz",
"has_sig": false,
"md5_digest": "64502035641f2266c2afb35c24292130",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 259553,
"upload_time": "2023-07-03T07:09:03",
"upload_time_iso_8601": "2023-07-03T07:09:03.375318Z",
"url": "https://files.pythonhosted.org/packages/93/cf/5cffb5e6a0f28c6ebd7114741b35e3a11528c759944c048b27c0722e7585/oic-1.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-03 07:09:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CZ-NIC",
"github_project": "pyoidc",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"appveyor": true,
"tox": true,
"lcname": "oic"
}
JSON
