chatgpt-auth 0.1.0__tar.gz

chatgpt_auth-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

chatgpt_auth-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include tests *.py

chatgpt_auth-0.1.0/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.4
+Name: chatgpt-auth
+Version: 0.1.0
+Summary: Sign in with ChatGPT: CLI and Python API for a single stored OAuth connection
+Author: ftnext
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/ftnext/sign-in-with-chatgpt-py/tree/main/chatgpt-auth
+Project-URL: Changelog, https://github.com/ftnext/sign-in-with-chatgpt-py/releases
+Project-URL: Issues, https://github.com/ftnext/sign-in-with-chatgpt-py/issues
+Project-URL: CI, https://github.com/ftnext/sign-in-with-chatgpt-py/actions
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx<1,>=0.28
+Requires-Dist: PyJWT[crypto]<3,>=2.10
+Requires-Dist: click
+Dynamic: license-file
+
+# chatgpt-auth
+
+Sign in to a ChatGPT Plus/Pro/Team account once and get OpenAI access tokens
+with automatic refresh — for CLIs, bots, and server jobs.
+
+Tokens and refresh tokens are stored on the local filesystem with strict
+permissions. Nothing about this package talks to OpenAI except the OAuth
+flow itself.
+
+## Install
+
+```console
+$ pip install chatgpt-auth
+```
+
+## Quick start
+
+Sign in once from a machine with a browser:
+
+```console
+$ chatgpt-auth login
+```
+
+Then get an access token anywhere (expired tokens are refreshed and saved
+automatically):
+
+```console
+$ TOKEN=$(chatgpt-auth print-access-token)
+$ curl -sS https://api.openai.com/v1/models -H "Authorization: Bearer $TOKEN"
+```
+
+From Python:
+
+```python
+from chatgpt_auth import Credentials
+
+credentials = Credentials.load()
+token = credentials.get_access_token()  # refreshes + saves if needed
+```
+
+Force a refresh or inspect state:
+
+```console
+$ chatgpt-auth refresh
+$ chatgpt-auth status
+$ chatgpt-auth logout
+```
+
+## CLI
+
+- `login` — run the browser sign-in (`--manual` pastes the URL/redirect
+  instead; `--replace` replaces an existing connection; `--timeout`,
+  `--port`, `--agent-name` tune the flow).
+- `status` — show the local connection state (offline, never prints tokens).
+- `print-access-token` — print the current access token (refreshing first
+  if needed). This is the only command that prints a token.
+- `refresh` — force a token refresh.
+- `logout` — wipe local tokens and try to revoke the refresh token
+  remotely. Local sign-out happens even if revocation cannot be
+  confirmed; to fully sign out everywhere also revoke the session in
+  ChatGPT Settings.
+
+All commands take `--credentials PATH` to point at a credentials file.
+
+## Credentials file resolution
+
+`Credentials.load()` / the CLI resolve the credentials path in this order:
+
+1. The explicit `path` argument / `--credentials` option.
+2. The `CHATGPT_AUTH_CREDENTIALS` environment variable.
+3. `${XDG_CONFIG_HOME:-~/.config}/chatgpt-auth/credentials.json`
+   (a relative `XDG_CONFIG_HOME` is ignored per the XDG spec).
+
+Relative paths resolve against the current working directory; `~` is
+expanded. Reserved aux names (`host.json`, `pending.json`, `runtime.lock`,
+`login.lock`, `models.json`) are rejected as credentials paths.
+
+## Auto refresh and saved tokens
+
+`get_access_token()` re-checks the store on every call and refreshes when
+the token expires within ~60 seconds, saving the new token before
+returning it. When a refresh's outcome is unknowable (e.g. the network
+died mid-request) the connection is retired rather than risking a
+double-submit of a single-use refresh token; the next call raises
+`ReauthorizationRequiredError` and `login` is required again. A write
+failure after a successful refresh returns no token — the object refuses
+further use if even retiring the connection cannot be persisted.
+
+## Sharing a store with llm-chatgpt-plan
+
+Point `--credentials`/`CHATGPT_AUTH_CREDENTIALS` at the existing
+`credentials.json` used by `llm-chatgpt-plan` to share the same connection,
+`host.json`, `pending.json`, and both lock files — so sign-ins and token
+use in both tools serialize correctly. This package never touches the
+`models.json` model cache; a new connection bumps `generation`, which is
+how `llm-chatgpt-plan` invalidates its cached model list. Files named
+anything other than `credentials.json` get their own `.<name>-suffixed`
+aux files and share nothing with other stores.
+
+## Concurrent use
+
+Multiple processes may hold `Credentials` for the same path. Refresh
+requests collapse onto a shared `fcntl.flock` runtime lock, so two
+processes do not double-submit a refresh. If another process signs out
+or signs in underneath you, the next call raises
+`ReauthorizationRequiredError` or `ConnectionChangedError`.
+
+## OS support
+
+macOS and Linux (POSIX `fcntl` locking). Windows is not supported in this
+version.
+
+## Security notes
+
+- The credentials directory must be owned by you and not group/world
+  readable; token files are written `0600`.
+- Tokens, refresh tokens, authorization codes, and PKCE verifiers never
+  appear in logs or exception messages.
+- `logout` clears local state first so an interrupted run still leaves
+  the connection dead, then revokes the refresh token; a broken
+  credentials file is the limit of what local sign-out can guarantee.
+
+## API summary
+
+```python
+import chatgpt_auth
+
+credentials = chatgpt_auth.Credentials.load()       # local file only
+token = credentials.get_access_token()              # auto refresh + save
+token = credentials.refresh()                       # forced refresh
+credentials = chatgpt_auth.login()                  # browser sign-in
+status = chatgpt_auth.status()                      # AuthStatus (local only)
+result = chatgpt_auth.logout()                      # LogoutResult
+```
+
+Exceptions (`chatgpt_auth` namespace): `SignInRequiredError`,
+`ReauthorizationRequiredError`, `ConnectionChangedError`,
+`PlanPermissionError`, `NetworkError`, `StorageError`, `LoginTimeoutError`,
+`AuthError`, and the base `ChatGPTAuthError`.
+
+## Development
+
+Run from this package directory:
+
+```console
+$ uv sync
+$ uv run pytest
+$ uv run ruff check .
+$ uv build
+```
+
+## Releases
+
+Publish a GitHub Release tagged `chatgpt-auth-<version>` matching
+`project.version` in `pyproject.toml`. The first release tag is
+`chatgpt-auth-0.1.0`. The `publish-chatgpt-auth.yml` workflow verifies the
+tag, tests Python 3.11–3.14, builds this package's wheel and sdist, and
+publishes them to PyPI using Trusted Publishing. Releases for other
+packages are skipped.

chatgpt_auth-0.1.0/README.md

@@ -0,0 +1,159 @@
+# chatgpt-auth
+
+Sign in to a ChatGPT Plus/Pro/Team account once and get OpenAI access tokens
+with automatic refresh — for CLIs, bots, and server jobs.
+
+Tokens and refresh tokens are stored on the local filesystem with strict
+permissions. Nothing about this package talks to OpenAI except the OAuth
+flow itself.
+
+## Install
+
+```console
+$ pip install chatgpt-auth
+```
+
+## Quick start
+
+Sign in once from a machine with a browser:
+
+```console
+$ chatgpt-auth login
+```
+
+Then get an access token anywhere (expired tokens are refreshed and saved
+automatically):
+
+```console
+$ TOKEN=$(chatgpt-auth print-access-token)
+$ curl -sS https://api.openai.com/v1/models -H "Authorization: Bearer $TOKEN"
+```
+
+From Python:
+
+```python
+from chatgpt_auth import Credentials
+
+credentials = Credentials.load()
+token = credentials.get_access_token()  # refreshes + saves if needed
+```
+
+Force a refresh or inspect state:
+
+```console
+$ chatgpt-auth refresh
+$ chatgpt-auth status
+$ chatgpt-auth logout
+```
+
+## CLI
+
+- `login` — run the browser sign-in (`--manual` pastes the URL/redirect
+  instead; `--replace` replaces an existing connection; `--timeout`,
+  `--port`, `--agent-name` tune the flow).
+- `status` — show the local connection state (offline, never prints tokens).
+- `print-access-token` — print the current access token (refreshing first
+  if needed). This is the only command that prints a token.
+- `refresh` — force a token refresh.
+- `logout` — wipe local tokens and try to revoke the refresh token
+  remotely. Local sign-out happens even if revocation cannot be
+  confirmed; to fully sign out everywhere also revoke the session in
+  ChatGPT Settings.
+
+All commands take `--credentials PATH` to point at a credentials file.
+
+## Credentials file resolution
+
+`Credentials.load()` / the CLI resolve the credentials path in this order:
+
+1. The explicit `path` argument / `--credentials` option.
+2. The `CHATGPT_AUTH_CREDENTIALS` environment variable.
+3. `${XDG_CONFIG_HOME:-~/.config}/chatgpt-auth/credentials.json`
+   (a relative `XDG_CONFIG_HOME` is ignored per the XDG spec).
+
+Relative paths resolve against the current working directory; `~` is
+expanded. Reserved aux names (`host.json`, `pending.json`, `runtime.lock`,
+`login.lock`, `models.json`) are rejected as credentials paths.
+
+## Auto refresh and saved tokens
+
+`get_access_token()` re-checks the store on every call and refreshes when
+the token expires within ~60 seconds, saving the new token before
+returning it. When a refresh's outcome is unknowable (e.g. the network
+died mid-request) the connection is retired rather than risking a
+double-submit of a single-use refresh token; the next call raises
+`ReauthorizationRequiredError` and `login` is required again. A write
+failure after a successful refresh returns no token — the object refuses
+further use if even retiring the connection cannot be persisted.
+
+## Sharing a store with llm-chatgpt-plan
+
+Point `--credentials`/`CHATGPT_AUTH_CREDENTIALS` at the existing
+`credentials.json` used by `llm-chatgpt-plan` to share the same connection,
+`host.json`, `pending.json`, and both lock files — so sign-ins and token
+use in both tools serialize correctly. This package never touches the
+`models.json` model cache; a new connection bumps `generation`, which is
+how `llm-chatgpt-plan` invalidates its cached model list. Files named
+anything other than `credentials.json` get their own `.<name>-suffixed`
+aux files and share nothing with other stores.
+
+## Concurrent use
+
+Multiple processes may hold `Credentials` for the same path. Refresh
+requests collapse onto a shared `fcntl.flock` runtime lock, so two
+processes do not double-submit a refresh. If another process signs out
+or signs in underneath you, the next call raises
+`ReauthorizationRequiredError` or `ConnectionChangedError`.
+
+## OS support
+
+macOS and Linux (POSIX `fcntl` locking). Windows is not supported in this
+version.
+
+## Security notes
+
+- The credentials directory must be owned by you and not group/world
+  readable; token files are written `0600`.
+- Tokens, refresh tokens, authorization codes, and PKCE verifiers never
+  appear in logs or exception messages.
+- `logout` clears local state first so an interrupted run still leaves
+  the connection dead, then revokes the refresh token; a broken
+  credentials file is the limit of what local sign-out can guarantee.
+
+## API summary
+
+```python
+import chatgpt_auth
+
+credentials = chatgpt_auth.Credentials.load()       # local file only
+token = credentials.get_access_token()              # auto refresh + save
+token = credentials.refresh()                       # forced refresh
+credentials = chatgpt_auth.login()                  # browser sign-in
+status = chatgpt_auth.status()                      # AuthStatus (local only)
+result = chatgpt_auth.logout()                      # LogoutResult
+```
+
+Exceptions (`chatgpt_auth` namespace): `SignInRequiredError`,
+`ReauthorizationRequiredError`, `ConnectionChangedError`,
+`PlanPermissionError`, `NetworkError`, `StorageError`, `LoginTimeoutError`,
+`AuthError`, and the base `ChatGPTAuthError`.
+
+## Development
+
+Run from this package directory:
+
+```console
+$ uv sync
+$ uv run pytest
+$ uv run ruff check .
+$ uv build
+```
+
+## Releases
+
+Publish a GitHub Release tagged `chatgpt-auth-<version>` matching
+`project.version` in `pyproject.toml`. The first release tag is
+`chatgpt-auth-0.1.0`. The `publish-chatgpt-auth.yml` workflow verifies the
+tag, tests Python 3.11–3.14, builds this package's wheel and sdist, and
+publishes them to PyPI using Trusted Publishing. Releases for other
+packages are skipped.

chatgpt_auth-0.1.0/chatgpt_auth/__init__.py

@@ -0,0 +1,36 @@
+"""chatgpt-auth: Sign in with ChatGPT for CLI and Python applications."""
+
+from .credentials import Credentials
+from .errors import (
+    AuthError,
+    ChatGPTAuthError,
+    ConnectionChangedError,
+    LoginTimeoutError,
+    NetworkError,
+    PlanPermissionError,
+    ReauthorizationRequiredError,
+    SignInRequiredError,
+    StorageError,
+)
+from .service import login, logout, status
+from .types import AuthStatus, LogoutResult
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "AuthError",
+    "AuthStatus",
+    "ChatGPTAuthError",
+    "ConnectionChangedError",
+    "Credentials",
+    "LoginTimeoutError",
+    "LogoutResult",
+    "NetworkError",
+    "PlanPermissionError",
+    "ReauthorizationRequiredError",
+    "SignInRequiredError",
+    "StorageError",
+    "login",
+    "logout",
+    "status",
+]

chatgpt_auth-0.1.0/chatgpt_auth/__main__.py

@@ -0,0 +1,4 @@
+from .cli import main
+
+if __name__ == "__main__":
+    main()