oidc-client


Nameoidc-client JSON
Version 0.2.5 PyPI version JSON
download
home_pagehttps://gitlab.com/lzinsou/oidc-client
SummaryA pure-Python OpenID Connect client
upload_time2023-04-26 15:39:25
maintainer
docs_urlNone
authorLoris Zinsou
requires_python>=3.10,<4.0
license
keywords openid oidc oauth oauth2
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            OIDC Client
===========

A pure-Python OpenID Connect client supporting OAuth 2.1 authorization flows, built for Python 3.10+ with minimal dependencies.

OAuth 2.1 authorization flows include:
- the **authorization code** flow, for interactive user login;
- the **client credentials** flow, for confidential machine-to-machine communication.

This OIDC Client supports reading configuration profiles from a `pyproject.toml` file.


Requirements
------------

Python 3.10+



Installation
------------

```console
pip install oidc-client
```


Configuration
-------------

To enable interactive login for your project, add the following to your `pyproject.toml`:
```toml
[tool.oidc]
issuer = "https://example.com"  # URL of your OIDC provider
client_id = "<application ID>"  # Application ID given by your OIDC provider
```


Examples
--------

```console
# To log-in as a user, using a web browser:
oidc login --interactive
```


License
-------

This project is licensed under the terms of the MIT license.


A [YZR](https://www.yzr.ai/) Free and Open Source project.

            

Raw data

            {
    "_id": null,
    "home_page": "https://gitlab.com/lzinsou/oidc-client",
    "name": "oidc-client",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "openid,oidc,oauth,oauth2",
    "author": "Loris Zinsou",
    "author_email": "lzinsou@proton.me",
    "download_url": "https://files.pythonhosted.org/packages/a3/5f/ed819ca089d442123eead88b490d8ba08aade7931111648fabf08808b3a6/oidc_client-0.2.5.tar.gz",
    "platform": null,
    "description": "OIDC Client\n===========\n\nA pure-Python OpenID Connect client supporting OAuth 2.1 authorization flows, built for Python 3.10+ with minimal dependencies.\n\nOAuth 2.1 authorization flows include:\n- the **authorization code** flow, for interactive user login;\n- the **client credentials** flow, for confidential machine-to-machine communication.\n\nThis OIDC Client supports reading configuration profiles from a `pyproject.toml` file.\n\n\nRequirements\n------------\n\nPython 3.10+\n\n\n\nInstallation\n------------\n\n```console\npip install oidc-client\n```\n\n\nConfiguration\n-------------\n\nTo enable interactive login for your project, add the following to your `pyproject.toml`:\n```toml\n[tool.oidc]\nissuer = \"https://example.com\"  # URL of your OIDC provider\nclient_id = \"<application ID>\"  # Application ID given by your OIDC provider\n```\n\n\nExamples\n--------\n\n```console\n# To log-in as a user, using a web browser:\noidc login --interactive\n```\n\n\nLicense\n-------\n\nThis project is licensed under the terms of the MIT license.\n\n\nA [YZR](https://www.yzr.ai/) Free and Open Source project.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A pure-Python OpenID Connect client",
    "version": "0.2.5",
    "split_keywords": [
        "openid",
        "oidc",
        "oauth",
        "oauth2"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b4b895ea8b6af7a0d68b0f90037cd4c751cf68ce25568d97a9169f125b894a24",
                "md5": "7551af0eeb937e102ede3a3d7d0450cd",
                "sha256": "1011525e32a796941f56a3ee60821f74dca14f21da29426b68bd2fcbad74218d"
            },
            "downloads": -1,
            "filename": "oidc_client-0.2.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7551af0eeb937e102ede3a3d7d0450cd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 14940,
            "upload_time": "2023-04-26T15:39:23",
            "upload_time_iso_8601": "2023-04-26T15:39:23.732648Z",
            "url": "https://files.pythonhosted.org/packages/b4/b8/95ea8b6af7a0d68b0f90037cd4c751cf68ce25568d97a9169f125b894a24/oidc_client-0.2.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a35fed819ca089d442123eead88b490d8ba08aade7931111648fabf08808b3a6",
                "md5": "5ebe04ab29f2039692d8ecd9aad9e0fe",
                "sha256": "8a4600eda138c2b4498be47ccf83f5689ce1d1b8ff30e3d389db9675cf7bd38b"
            },
            "downloads": -1,
            "filename": "oidc_client-0.2.5.tar.gz",
            "has_sig": false,
            "md5_digest": "5ebe04ab29f2039692d8ecd9aad9e0fe",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 11979,
            "upload_time": "2023-04-26T15:39:25",
            "upload_time_iso_8601": "2023-04-26T15:39:25.339792Z",
            "url": "https://files.pythonhosted.org/packages/a3/5f/ed819ca089d442123eead88b490d8ba08aade7931111648fabf08808b3a6/oidc_client-0.2.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-04-26 15:39:25",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "gitlab_user": "lzinsou",
    "gitlab_project": "oidc-client",
    "lcname": "oidc-client"
}
        
Elapsed time: 0.08257s