Requests-OIDC
=================
.. inclusion-marker-do-not-remove
Implements a simple API for creating a requests ``Session`` that
manages your OIDC-discovered OAuth2 session for you.
::
pip install requests-oidc
.. code-block:: python
from requests_oidc import make_auth_code_session
from requests_oidc.plugins import OSCachedPlugin
oidc_url = "https://your-oidc-provider.com/.well-known/openid-configuration"
client_id = "your-app"
port = 8675
scope = ["openid", "email", "profile"]
plugin = OSCachedPlugin("your-app", "your-company")
session = make_auth_code_session(oidc_url, client_id, port, scope, plugin=plugin)
.. list-table::
* - Package
- |pypi| |license| |py status| |formats| |python| |py impls| |downloads|
* - build
- |checks| |rtd build| |coverage|
* - Git
- |last commit| |commit activity| |commits since| |issues| |prs|
.. |pypi| image:: https://img.shields.io/pypi/v/requests-oidc
:target: https://pypi.org/project/requests-oidc/
:alt: PyPI
.. |downloads| image:: https://img.shields.io/pypi/dm/requests-oidc
:target: https://pypistats.org/packages/requests-oidc
:alt: PyPI - Downloads
.. |formats| image:: https://img.shields.io/pypi/format/requests-oidc
:target: https://pypi.org/project/requests-oidc/
:alt: PyPI - Format
.. |py status| image:: https://img.shields.io/pypi/status/requests-oidc
:target: https://pypi.org/project/requests-oidc/
:alt: PyPI - Status
.. |py impls| image:: https://img.shields.io/pypi/implementation/requests-oidc
:target: https://pypi.org/project/requests-oidc/
:alt: PyPI - Implementation
.. |python| image:: https://img.shields.io/pypi/pyversions/requests-oidc
:target: https://pypi.org/project/requests-oidc/
:alt: PyPI - Python Version
.. |license| image:: https://img.shields.io/github/license/tsweeney-dust/requests-oidc
:target: https://github.com/tsweeney-dust/requests-oidc
:alt: GitHub
.. |checks| image:: https://img.shields.io/github/checks-status/tsweeney-dust/requests-oidc/main?logo=github
:target: https://github.com/tsweeney-dust/requests-oidc
:alt: GitHub branch checks state
.. |rtd build| image:: https://img.shields.io/readthedocs/requests-oidc
:target: https://requests-oidc.readthedocs.io/en/latest/?badge=latest
:alt: Read the Docs
.. |coverage| image:: https://coveralls.io/repos/github/tsweeney-dust/requests-oidc/badge.svg?branch=main
:target: https://coveralls.io/github/tsweeney-dust/requests-oidc?branch=main
:alt: Coverage
.. |last commit| image:: https://img.shields.io/github/last-commit/tsweeney-dust/requests-oidc
:target: https://github.com/tsweeney-dust/requests-oidc
:alt: GitHub last commit
.. |commit activity| image:: https://img.shields.io/github/commit-activity/m/tsweeney-dust/requests-oidc
:target: https://github.com/tsweeney-dust/requests-oidc
:alt: GitHub commit activity
.. |commits since| image:: https://img.shields.io/github/commits-since/tsweeney-dust/requests-oidc/latest
:target: https://github.com/tsweeney-dust/requests-oidc
:alt: GitHub commits since latest release (by SemVer)
.. |issues| image:: https://img.shields.io/github/issues/tsweeney-dust/requests-oidc
:target: https://github.com/tsweeney-dust/requests-oidc/issues
:alt: GitHub issues
.. |prs| image:: https://img.shields.io/github/issues-pr/tsweeney-dust/requests-oidc
:target: https://github.com/tsweeney-dust/requests-oidc/pulls
:alt: GitHub pull requests
Raw data
{
"_id": null,
"home_page": "https://github.com/tsweeney-dust/requests-oidc",
"name": "requests-oidc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4",
"maintainer_email": "",
"keywords": "",
"author": "Tristan Sweeney",
"author_email": "tsweeney@dustidentity.com",
"download_url": "https://files.pythonhosted.org/packages/ae/c5/5513f65d7b51ad824fcb19f04e4f3acc72b126c19d95115a27a32eb38db7/requests_oidc-0.6.2.tar.gz",
"platform": null,
"description": "Requests-OIDC\n=================\n\n.. inclusion-marker-do-not-remove\n\nImplements a simple API for creating a requests ``Session`` that\nmanages your OIDC-discovered OAuth2 session for you.\n\n::\n\n pip install requests-oidc\n\n.. code-block:: python\n\n from requests_oidc import make_auth_code_session\n from requests_oidc.plugins import OSCachedPlugin\n\n oidc_url = \"https://your-oidc-provider.com/.well-known/openid-configuration\"\n client_id = \"your-app\"\n port = 8675\n scope = [\"openid\", \"email\", \"profile\"]\n\n plugin = OSCachedPlugin(\"your-app\", \"your-company\")\n\n\n\n session = make_auth_code_session(oidc_url, client_id, port, scope, plugin=plugin)\n\n\n.. list-table::\n\n * - Package\n - |pypi| |license| |py status| |formats| |python| |py impls| |downloads|\n * - build\n - |checks| |rtd build| |coverage|\n * - Git\n - |last commit| |commit activity| |commits since| |issues| |prs|\n\n.. |pypi| image:: https://img.shields.io/pypi/v/requests-oidc\n :target: https://pypi.org/project/requests-oidc/\n :alt: PyPI\n \n.. |downloads| image:: https://img.shields.io/pypi/dm/requests-oidc\n :target: https://pypistats.org/packages/requests-oidc\n :alt: PyPI - Downloads\n\n.. |formats| image:: https://img.shields.io/pypi/format/requests-oidc\n :target: https://pypi.org/project/requests-oidc/\n :alt: PyPI - Format\n\n.. |py status| image:: https://img.shields.io/pypi/status/requests-oidc\n :target: https://pypi.org/project/requests-oidc/\n :alt: PyPI - Status\n\n.. |py impls| image:: https://img.shields.io/pypi/implementation/requests-oidc\n :target: https://pypi.org/project/requests-oidc/\n :alt: PyPI - Implementation\n\n.. |python| image:: https://img.shields.io/pypi/pyversions/requests-oidc\n :target: https://pypi.org/project/requests-oidc/\n :alt: PyPI - Python Version\n\n.. |license| image:: https://img.shields.io/github/license/tsweeney-dust/requests-oidc\n :target: https://github.com/tsweeney-dust/requests-oidc\n :alt: GitHub\n\n.. |checks| image:: https://img.shields.io/github/checks-status/tsweeney-dust/requests-oidc/main?logo=github\n :target: https://github.com/tsweeney-dust/requests-oidc\n :alt: GitHub branch checks state\n\n.. |rtd build| image:: https://img.shields.io/readthedocs/requests-oidc\n :target: https://requests-oidc.readthedocs.io/en/latest/?badge=latest\n :alt: Read the Docs\n\n.. |coverage| image:: https://coveralls.io/repos/github/tsweeney-dust/requests-oidc/badge.svg?branch=main\n :target: https://coveralls.io/github/tsweeney-dust/requests-oidc?branch=main\n :alt: Coverage\n\n.. |last commit| image:: https://img.shields.io/github/last-commit/tsweeney-dust/requests-oidc\n :target: https://github.com/tsweeney-dust/requests-oidc\n :alt: GitHub last commit\n\n.. |commit activity| image:: https://img.shields.io/github/commit-activity/m/tsweeney-dust/requests-oidc\n :target: https://github.com/tsweeney-dust/requests-oidc\n :alt: GitHub commit activity\n\n.. |commits since| image:: https://img.shields.io/github/commits-since/tsweeney-dust/requests-oidc/latest\n :target: https://github.com/tsweeney-dust/requests-oidc\n :alt: GitHub commits since latest release (by SemVer)\n\n.. |issues| image:: https://img.shields.io/github/issues/tsweeney-dust/requests-oidc\n :target: https://github.com/tsweeney-dust/requests-oidc/issues\n :alt: GitHub issues\n\n.. |prs| image:: https://img.shields.io/github/issues-pr/tsweeney-dust/requests-oidc\n :target: https://github.com/tsweeney-dust/requests-oidc/pulls\n :alt: GitHub pull requests",
"bugtrack_url": null,
"license": "MIT",
"summary": "",
"version": "0.6.2",
"project_urls": {
"Documentation": "https://requests-oidc.readthedocs.io/en/latest/",
"Homepage": "https://github.com/tsweeney-dust/requests-oidc",
"Repository": "https://github.com/tsweeney-dust/requests-oidc"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1a8d476afe3e170b32531705f5b6b1fa00684fb45a504454eecd3ad0a9f5e393",
"md5": "2f78d4e466a64fda27e6f2658c968d8f",
"sha256": "227fbcc561d0acb54469d62a7d4bde055a8eeee7968cdb98fa732e0d2313d814"
},
"downloads": -1,
"filename": "requests_oidc-0.6.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2f78d4e466a64fda27e6f2658c968d8f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4",
"size": 12740,
"upload_time": "2023-05-25T21:02:10",
"upload_time_iso_8601": "2023-05-25T21:02:10.705013Z",
"url": "https://files.pythonhosted.org/packages/1a/8d/476afe3e170b32531705f5b6b1fa00684fb45a504454eecd3ad0a9f5e393/requests_oidc-0.6.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aec55513f65d7b51ad824fcb19f04e4f3acc72b126c19d95115a27a32eb38db7",
"md5": "34f763107bb519e38ac07d28046d692c",
"sha256": "84ea777457067f8f67fe25534b9c153f3f9a45336c83e073a93ce735a86406ca"
},
"downloads": -1,
"filename": "requests_oidc-0.6.2.tar.gz",
"has_sig": false,
"md5_digest": "34f763107bb519e38ac07d28046d692c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4",
"size": 8905,
"upload_time": "2023-05-25T21:02:13",
"upload_time_iso_8601": "2023-05-25T21:02:13.668522Z",
"url": "https://files.pythonhosted.org/packages/ae/c5/5513f65d7b51ad824fcb19f04e4f3acc72b126c19d95115a27a32eb38db7/requests_oidc-0.6.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-25 21:02:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tsweeney-dust",
"github_project": "requests-oidc",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "requests-oidc"
}