TerevintoSoftware.PkceClient


NameTerevintoSoftware.PkceClient JSON
Version 0.1.0 PyPI version JSON
download
home_page
SummaryA Python package to deal with OAuth PKCE authentication flow to generate JWT tokens from desktop apps.
upload_time2023-11-26 19:23:00
maintainer
docs_urlNone
author
requires_python>=3.8
licenseMIT License Copyright (c) 2022 Camilo Terevinto Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords oauth oidc pkce
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Python PKCE Client

This python package contains a simple client to request tokens using the OAuth 2/OIDC Authorization Code PKCE flow.

## Sample usage

```python
from terevintosoftware.pkce_client import PkceClient, PkceLoginConfig

config = PkceLoginConfig(
    authorization_uri="https://localhost:44300/connect/authorize",
    token_uri="https://localhost:44300/connect/token",
    scopes=[ "openid", "profile", "api" ],
    client_id="python-nb",
    internal_port=8888,
    add_random_state=True,
    random_state_length=32,
    verify_authorization_server_https=False
)

login_client = PkceClient(config)
pkce_token = login_client.login()
headers = { "Authorization": "Bearer " + str(pkce_token.access_token) }
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "TerevintoSoftware.PkceClient",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "oauth,oidc,pkce",
    "author": "",
    "author_email": "Camilo Terevinto <software@camiloterevinto.com>",
    "download_url": "https://files.pythonhosted.org/packages/56/1e/ff7978824bc80142bf6b2e905366f71b5c64f881653a9ffcf8a6528f39c2/TerevintoSoftware.PkceClient-0.1.0.tar.gz",
    "platform": null,
    "description": "# Python PKCE Client\n\nThis python package contains a simple client to request tokens using the OAuth 2/OIDC Authorization Code PKCE flow.\n\n## Sample usage\n\n```python\nfrom terevintosoftware.pkce_client import PkceClient, PkceLoginConfig\n\nconfig = PkceLoginConfig(\n    authorization_uri=\"https://localhost:44300/connect/authorize\",\n    token_uri=\"https://localhost:44300/connect/token\",\n    scopes=[ \"openid\", \"profile\", \"api\" ],\n    client_id=\"python-nb\",\n    internal_port=8888,\n    add_random_state=True,\n    random_state_length=32,\n    verify_authorization_server_https=False\n)\n\nlogin_client = PkceClient(config)\npkce_token = login_client.login()\nheaders = { \"Authorization\": \"Bearer \" + str(pkce_token.access_token) }\n```\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2022 Camilo Terevinto  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "A Python package to deal with OAuth PKCE authentication flow to generate JWT tokens from desktop apps.",
    "version": "0.1.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/CamiloTerevinto/TerevintoSoftware.PythonPkceClient/issues",
        "Homepage": "https://github.com/CamiloTerevinto/TerevintoSoftware.PythonPkceClient"
    },
    "split_keywords": [
        "oauth",
        "oidc",
        "pkce"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "770d62e3f854874b314baf5228a9f1a165c2c8f0b81f8b81e9b1753a3d87ee3b",
                "md5": "62f0523baa7ad09d437d1a78aee92017",
                "sha256": "c04a9ad74faaf40bc54cf13000b5630733d7f1493ea7cdd2d03fb559d830d2dc"
            },
            "downloads": -1,
            "filename": "TerevintoSoftware.PkceClient-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "62f0523baa7ad09d437d1a78aee92017",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 9054,
            "upload_time": "2023-11-26T19:22:58",
            "upload_time_iso_8601": "2023-11-26T19:22:58.925973Z",
            "url": "https://files.pythonhosted.org/packages/77/0d/62e3f854874b314baf5228a9f1a165c2c8f0b81f8b81e9b1753a3d87ee3b/TerevintoSoftware.PkceClient-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "561eff7978824bc80142bf6b2e905366f71b5c64f881653a9ffcf8a6528f39c2",
                "md5": "6fecb03e508f5d2bd36c22e2d7a5733d",
                "sha256": "da1ba1608dab27478297ec3a40dd78b6d66cc4f49c37a8b272330bf816e0d204"
            },
            "downloads": -1,
            "filename": "TerevintoSoftware.PkceClient-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "6fecb03e508f5d2bd36c22e2d7a5733d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 5804,
            "upload_time": "2023-11-26T19:23:00",
            "upload_time_iso_8601": "2023-11-26T19:23:00.755694Z",
            "url": "https://files.pythonhosted.org/packages/56/1e/ff7978824bc80142bf6b2e905366f71b5c64f881653a9ffcf8a6528f39c2/TerevintoSoftware.PkceClient-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-26 19:23:00",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "CamiloTerevinto",
    "github_project": "TerevintoSoftware.PythonPkceClient",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "terevintosoftware.pkceclient"
}
        
Elapsed time: 0.14424s