flask-githubkit 0.1.2__tar.gz → 0.1.3__tar.gz

{flask_githubkit-0.1.2/src/flask_githubkit.egg-info → flask_githubkit-0.1.3}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.4
 Name: flask-githubkit
-Version: 0.1.2
+Version: 0.1.3
 Summary: Flask extension for GitHub OAuth login, built on GitHubKit. Handles expiring-token refresh and server-side sessions.
 Author: LJFCoding
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/LJFCoding/flask-githubkit
 Project-URL: Repository, https://github.com/LJFCoding/flask-githubkit
 Project-URL: Issues, https://github.com/LJFCoding/flask-githubkit/issues
+Project-URL: Documentation, https://flask-githubkit.readthedocs.io/en/latest/
 Keywords: flask,github,githubkit,oauth,authentication
 Classifier: Framework :: Flask
 Classifier: Intended Audience :: Developers
@@ -35,16 +36,24 @@ A Flask extension for GitHub OAuth login, built on
 [GitHubKit](https://github.com/yanyongyu/githubkit). It handles expiring-token
 refresh and stores tokens in `flask.session`.
 
+Documentation: [flask-githubkit.readthedocs.io](https://flask-githubkit.readthedocs.io/en/latest/)
+
 ## Installation
 
-Install the release directly from GitHub:
+Install the latest release from PyPI:
+
+```console
+pip install flask-githubkit
+```
+
+To pin a release or install directly from GitHub:
 
 ```console
-pip install "flask-githubkit @ git+https://github.com/LJFCoding/flask-githubkit.git@v0.1.2"
+pip install "flask-githubkit==0.1.3"
+pip install "flask-githubkit @ git+https://github.com/LJFCoding/flask-githubkit.git@v0.1.3"
 ```
 
-It is not published on PyPI yet, so `pip install flask-githubkit` will not
-find it. It requires Python 3.10+ and installs Flask, GitHubKit and httpx.
+It requires Python 3.10+ and installs Flask, GitHubKit and httpx.
 
 For local development, install the test dependencies with
 `pip install -e ".[test]"`.
@@ -141,15 +150,15 @@ def create_app():
 
 ## Examples
 
-Each file in [examples/](examples) is a complete app. They are checked by the
+Each file in [examples/](https://github.com/LJFCoding/flask-githubkit/tree/main/examples) is a complete app. They are checked by the
 test suite, which confirms the login route redirects to GitHub.
 
 | File | Shows |
 | --- | --- |
-| [single_file.py](examples/single_file.py) | A module-level app with `GitHub(app)` |
-| [factory.py](examples/factory.py) | An app factory with `init_app` and the optional config keys |
-| [blueprint.py](examples/blueprint.py) | Login routes in a blueprint; the `auth.login` endpoint is found from `@github.login` |
-| [routes.py](examples/routes.py) | A `login_required` decorator and a route that calls the GitHub API |
+| [single_file.py](https://github.com/LJFCoding/flask-githubkit/blob/main/examples/single_file.py) | A module-level app with `GitHub(app)` |
+| [factory.py](https://github.com/LJFCoding/flask-githubkit/blob/main/examples/factory.py) | An app factory with `init_app` and the optional config keys |
+| [blueprint.py](https://github.com/LJFCoding/flask-githubkit/blob/main/examples/blueprint.py) | Login routes in a blueprint; the `auth.login` endpoint is found from `@github.login` |
+| [routes.py](https://github.com/LJFCoding/flask-githubkit/blob/main/examples/routes.py) | A `login_required` decorator and a route that calls the GitHub API |
 
 Set `GITHUB_CLIENT_ID`, `GITHUB_CLIENT_SECRET` and `SECRET_KEY` in your
 environment, then run one with, for example,
@@ -202,7 +211,7 @@ github = flask_githubkit.GitHub(
   OAuth flow. You can also call `github.login()` inside a view and return
   the result, which is useful if you want to run code first. The decorated
   function's body never runs.
-- `@callback` wraps the callback view.
+- `@github.callback` wraps the callback view.
 - `client()` returns the request-cached GitHubKit `GitHub` client, or `None`
   when there is no valid stored token.
 - `logout()` removes the stored GitHub token from the session.

{flask_githubkit-0.1.2 → flask_githubkit-0.1.3}/README.md

@@ -4,16 +4,24 @@ A Flask extension for GitHub OAuth login, built on
 [GitHubKit](https://github.com/yanyongyu/githubkit). It handles expiring-token
 refresh and stores tokens in `flask.session`.
 
+Documentation: [flask-githubkit.readthedocs.io](https://flask-githubkit.readthedocs.io/en/latest/)
+
 ## Installation
 
-Install the release directly from GitHub:
+Install the latest release from PyPI:
+
+```console
+pip install flask-githubkit
+```
+
+To pin a release or install directly from GitHub:
 
 ```console
-pip install "flask-githubkit @ git+https://github.com/LJFCoding/flask-githubkit.git@v0.1.2"
+pip install "flask-githubkit==0.1.3"
+pip install "flask-githubkit @ git+https://github.com/LJFCoding/flask-githubkit.git@v0.1.3"
 ```
 
-It is not published on PyPI yet, so `pip install flask-githubkit` will not
-find it. It requires Python 3.10+ and installs Flask, GitHubKit and httpx.
+It requires Python 3.10+ and installs Flask, GitHubKit and httpx.
 
 For local development, install the test dependencies with
 `pip install -e ".[test]"`.
@@ -110,15 +118,15 @@ def create_app():
 
 ## Examples
 
-Each file in [examples/](examples) is a complete app. They are checked by the
+Each file in [examples/](https://github.com/LJFCoding/flask-githubkit/tree/main/examples) is a complete app. They are checked by the
 test suite, which confirms the login route redirects to GitHub.
 
 | File | Shows |
 | --- | --- |
-| [single_file.py](examples/single_file.py) | A module-level app with `GitHub(app)` |
-| [factory.py](examples/factory.py) | An app factory with `init_app` and the optional config keys |
-| [blueprint.py](examples/blueprint.py) | Login routes in a blueprint; the `auth.login` endpoint is found from `@github.login` |
-| [routes.py](examples/routes.py) | A `login_required` decorator and a route that calls the GitHub API |
+| [single_file.py](https://github.com/LJFCoding/flask-githubkit/blob/main/examples/single_file.py) | A module-level app with `GitHub(app)` |
+| [factory.py](https://github.com/LJFCoding/flask-githubkit/blob/main/examples/factory.py) | An app factory with `init_app` and the optional config keys |
+| [blueprint.py](https://github.com/LJFCoding/flask-githubkit/blob/main/examples/blueprint.py) | Login routes in a blueprint; the `auth.login` endpoint is found from `@github.login` |
+| [routes.py](https://github.com/LJFCoding/flask-githubkit/blob/main/examples/routes.py) | A `login_required` decorator and a route that calls the GitHub API |
 
 Set `GITHUB_CLIENT_ID`, `GITHUB_CLIENT_SECRET` and `SECRET_KEY` in your
 environment, then run one with, for example,
@@ -171,7 +179,7 @@ github = flask_githubkit.GitHub(
   OAuth flow. You can also call `github.login()` inside a view and return
   the result, which is useful if you want to run code first. The decorated
   function's body never runs.
-- `@callback` wraps the callback view.
+- `@github.callback` wraps the callback view.
 - `client()` returns the request-cached GitHubKit `GitHub` client, or `None`
   when there is no valid stored token.
 - `logout()` removes the stored GitHub token from the session.

{flask_githubkit-0.1.2 → flask_githubkit-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "flask-githubkit"
-version = "0.1.2"
+version = "0.1.3"
 description = "Flask extension for GitHub OAuth login, built on GitHubKit. Handles expiring-token refresh and server-side sessions."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -35,6 +35,7 @@ lint = ["ruff", "mypy"]
 Homepage = "https://github.com/LJFCoding/flask-githubkit"
 Repository = "https://github.com/LJFCoding/flask-githubkit"
 Issues = "https://github.com/LJFCoding/flask-githubkit/issues"
+Documentation = "https://flask-githubkit.readthedocs.io/en/latest/"
 
 [tool.setuptools.packages.find]
 where = ["src"]

{flask_githubkit-0.1.2 → flask_githubkit-0.1.3}/src/flask_githubkit/auth.py

@@ -57,6 +57,7 @@ class GitHub:
             self.init_app(app)
 
     def init_app(self, app: flask.Flask) -> None:
+        """Register the ``AuthExpiredError`` handler on ``app``."""
         app.register_error_handler(
             githubkit.exception.AuthExpiredError, self._expired
         )
@@ -98,6 +99,13 @@ class GitHub:
     def callback(
         self, view_func: collections.abc.Callable[..., ViewResult]
     ) -> collections.abc.Callable[..., ViewResult]:
+        """Wrap the callback view.
+
+        The wrapper checks the OAuth ``state``, exchanges the code and
+        saves the token. It then calls the view with the access token,
+        or with ``None`` if the user denied access.
+        """
+
         @functools.wraps(view_func)
         def wrapper(*args: typing.Any, **kwargs: typing.Any) -> ViewResult:
             if not self._check_state():
@@ -164,6 +172,7 @@ class GitHub:
         return github
 
     def logout(self) -> None:
+        """Remove the stored token and any cached client."""
         flask_githubkit.store.Token.clear()
         flask.g.pop(CLIENT_ATTR, None)
 

{flask_githubkit-0.1.2 → flask_githubkit-0.1.3/src/flask_githubkit.egg-info}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.4
 Name: flask-githubkit
-Version: 0.1.2
+Version: 0.1.3
 Summary: Flask extension for GitHub OAuth login, built on GitHubKit. Handles expiring-token refresh and server-side sessions.
 Author: LJFCoding
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/LJFCoding/flask-githubkit
 Project-URL: Repository, https://github.com/LJFCoding/flask-githubkit
 Project-URL: Issues, https://github.com/LJFCoding/flask-githubkit/issues
+Project-URL: Documentation, https://flask-githubkit.readthedocs.io/en/latest/
 Keywords: flask,github,githubkit,oauth,authentication
 Classifier: Framework :: Flask
 Classifier: Intended Audience :: Developers
@@ -35,16 +36,24 @@ A Flask extension for GitHub OAuth login, built on
 [GitHubKit](https://github.com/yanyongyu/githubkit). It handles expiring-token
 refresh and stores tokens in `flask.session`.
 
+Documentation: [flask-githubkit.readthedocs.io](https://flask-githubkit.readthedocs.io/en/latest/)
+
 ## Installation
 
-Install the release directly from GitHub:
+Install the latest release from PyPI:
+
+```console
+pip install flask-githubkit
+```
+
+To pin a release or install directly from GitHub:
 
 ```console
-pip install "flask-githubkit @ git+https://github.com/LJFCoding/flask-githubkit.git@v0.1.2"
+pip install "flask-githubkit==0.1.3"
+pip install "flask-githubkit @ git+https://github.com/LJFCoding/flask-githubkit.git@v0.1.3"
 ```
 
-It is not published on PyPI yet, so `pip install flask-githubkit` will not
-find it. It requires Python 3.10+ and installs Flask, GitHubKit and httpx.
+It requires Python 3.10+ and installs Flask, GitHubKit and httpx.
 
 For local development, install the test dependencies with
 `pip install -e ".[test]"`.
@@ -141,15 +150,15 @@ def create_app():
 
 ## Examples
 
-Each file in [examples/](examples) is a complete app. They are checked by the
+Each file in [examples/](https://github.com/LJFCoding/flask-githubkit/tree/main/examples) is a complete app. They are checked by the
 test suite, which confirms the login route redirects to GitHub.
 
 | File | Shows |
 | --- | --- |
-| [single_file.py](examples/single_file.py) | A module-level app with `GitHub(app)` |
-| [factory.py](examples/factory.py) | An app factory with `init_app` and the optional config keys |
-| [blueprint.py](examples/blueprint.py) | Login routes in a blueprint; the `auth.login` endpoint is found from `@github.login` |
-| [routes.py](examples/routes.py) | A `login_required` decorator and a route that calls the GitHub API |
+| [single_file.py](https://github.com/LJFCoding/flask-githubkit/blob/main/examples/single_file.py) | A module-level app with `GitHub(app)` |
+| [factory.py](https://github.com/LJFCoding/flask-githubkit/blob/main/examples/factory.py) | An app factory with `init_app` and the optional config keys |
+| [blueprint.py](https://github.com/LJFCoding/flask-githubkit/blob/main/examples/blueprint.py) | Login routes in a blueprint; the `auth.login` endpoint is found from `@github.login` |
+| [routes.py](https://github.com/LJFCoding/flask-githubkit/blob/main/examples/routes.py) | A `login_required` decorator and a route that calls the GitHub API |
 
 Set `GITHUB_CLIENT_ID`, `GITHUB_CLIENT_SECRET` and `SECRET_KEY` in your
 environment, then run one with, for example,
@@ -202,7 +211,7 @@ github = flask_githubkit.GitHub(
   OAuth flow. You can also call `github.login()` inside a view and return
   the result, which is useful if you want to run code first. The decorated
   function's body never runs.
-- `@callback` wraps the callback view.
+- `@github.callback` wraps the callback view.
 - `client()` returns the request-cached GitHubKit `GitHub` client, or `None`
   when there is no valid stored token.
 - `logout()` removes the stored GitHub token from the session.