kes-tools 0.1.0__tar.gz

kes_tools-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+.venv/
+__pycache__/
+.env
+build/
+.terraform/
+*.tfstate
+*.tfstate.*
+node_modules/
+frontend/dist/
+.idea/
+dist/

kes_tools-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

kes_tools-0.1.0/PKG-INFO

@@ -0,0 +1,60 @@
+Metadata-Version: 2.5
+Name: kes-tools
+Version: 0.1.0
+Summary: Command-line client for kes-tools: turn PDFs and Kurzweil 3000 .kes files into .kes files with Datalab OCR
+Project-URL: Website, https://dbqmri38t4eq6.cloudfront.net
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Text Processing
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.27
+Requires-Dist: keyring>=24
+Description-Content-Type: text/markdown
+
+# kes-tools
+
+Command-line client for the [kes-tools website](https://dbqmri38t4eq6.cloudfront.net), which turns PDFs and Kurzweil 3000 `.kes` files into `.kes` files with OCR, layout and reading order from [Datalab](https://www.datalab.to), tuned so Kurzweil reads whole sentences.
+
+Conversions run on the kes-tools website with your account and the Datalab API key you set up there, so they are billed to your Datalab account.
+
+## Install
+
+```bash
+uv tool install kes-tools        # or: pipx install kes-tools
+```
+
+Or run it without installing: `uvx kes-tools …`. Works on Windows, macOS and Linux with Python 3.9 or newer.
+
+## Sign in
+
+```bash
+kes-tools login
+```
+
+This opens your browser to sign in with your kes-tools account (email and password, or Google). The sign-in is kept in your system's keychain (macOS Keychain, Windows Credential Manager or the Linux Secret Service) and lasts a year. `kes-tools logout` signs out.
+
+On a machine without a browser or keychain, such as a server or CI job, run `kes-tools login --export` on your own computer, store the printed token as a secret, and set it as `KES_TOOLS_REFRESH_TOKEN` where the CLI runs. Anyone with that token can use your account until it expires or you run `kes-tools logout`.
+
+## Use
+
+```bash
+kes-tools convert book.pdf chapter*.kes -o converted/   # upload, wait and download the results
+kes-tools convert --no-wait *.pdf                        # only start the conversions
+kes-tools jobs                                           # list your conversions
+kes-tools download JOB_ID … -o converted/                # download finished conversions
+kes-tools delete JOB_ID …                                # delete conversions and their files
+kes-tools whoami                                         # who is signed in, and whether a Datalab key is set up
+```
+
+`convert` takes `--mode fast|balanced|accurate` (Datalab's mode, default `balanced`) and, for `.kes` files, `--image color|bitmap` (send the colour scan or the black-and-white text bitmap). Wildcards like `*.pdf` work in every shell, including PowerShell and cmd. Files are converted one at a time on the server; existing files in the output folder are kept and the new one gets " (2)" unless you pass `--overwrite`.
+
+Every command takes `--json` for machine-readable output. Exit codes: `0` success, `1` a conversion or download failed, `2` wrong arguments or files, `3` not signed in or the sign-in expired.
+
+`--url` or `KES_TOOLS_URL` points the CLI at another deployment of kes-tools.
+
+## License
+
+Apache License 2.0. The full text is in the LICENSE file included in the package.

kes_tools-0.1.0/README.md

@@ -0,0 +1,44 @@
+# kes-tools
+
+Command-line client for the [kes-tools website](https://dbqmri38t4eq6.cloudfront.net), which turns PDFs and Kurzweil 3000 `.kes` files into `.kes` files with OCR, layout and reading order from [Datalab](https://www.datalab.to), tuned so Kurzweil reads whole sentences.
+
+Conversions run on the kes-tools website with your account and the Datalab API key you set up there, so they are billed to your Datalab account.
+
+## Install
+
+```bash
+uv tool install kes-tools        # or: pipx install kes-tools
+```
+
+Or run it without installing: `uvx kes-tools …`. Works on Windows, macOS and Linux with Python 3.9 or newer.
+
+## Sign in
+
+```bash
+kes-tools login
+```
+
+This opens your browser to sign in with your kes-tools account (email and password, or Google). The sign-in is kept in your system's keychain (macOS Keychain, Windows Credential Manager or the Linux Secret Service) and lasts a year. `kes-tools logout` signs out.
+
+On a machine without a browser or keychain, such as a server or CI job, run `kes-tools login --export` on your own computer, store the printed token as a secret, and set it as `KES_TOOLS_REFRESH_TOKEN` where the CLI runs. Anyone with that token can use your account until it expires or you run `kes-tools logout`.
+
+## Use
+
+```bash
+kes-tools convert book.pdf chapter*.kes -o converted/   # upload, wait and download the results
+kes-tools convert --no-wait *.pdf                        # only start the conversions
+kes-tools jobs                                           # list your conversions
+kes-tools download JOB_ID … -o converted/                # download finished conversions
+kes-tools delete JOB_ID …                                # delete conversions and their files
+kes-tools whoami                                         # who is signed in, and whether a Datalab key is set up
+```
+
+`convert` takes `--mode fast|balanced|accurate` (Datalab's mode, default `balanced`) and, for `.kes` files, `--image color|bitmap` (send the colour scan or the black-and-white text bitmap). Wildcards like `*.pdf` work in every shell, including PowerShell and cmd. Files are converted one at a time on the server; existing files in the output folder are kept and the new one gets " (2)" unless you pass `--overwrite`.
+
+Every command takes `--json` for machine-readable output. Exit codes: `0` success, `1` a conversion or download failed, `2` wrong arguments or files, `3` not signed in or the sign-in expired.
+
+`--url` or `KES_TOOLS_URL` points the CLI at another deployment of kes-tools.
+
+## License
+
+Apache License 2.0. The full text is in the LICENSE file included in the package.

kes_tools-0.1.0/pyproject.toml

@@ -0,0 +1,31 @@
+[project]
+name = "kes-tools"
+version = "0.1.0"
+description = "Command-line client for kes-tools: turn PDFs and Kurzweil 3000 .kes files into .kes files with Datalab OCR"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.9"
+dependencies = ["httpx>=0.27", "keyring>=24"]
+classifiers = [
+    "Environment :: Console",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Text Processing",
+]
+
+[project.scripts]
+kes-tools = "kes_tools.cli:main"
+
+[project.urls]
+Website = "https://dbqmri38t4eq6.cloudfront.net"
+
+[dependency-groups]
+dev = ["pytest>=8"]
+
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]

kes_tools-0.1.0/src/kes_tools/__init__.py

@@ -0,0 +1,6 @@
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("kes-tools")
+except PackageNotFoundError:
+    __version__ = "0+unknown"

kes_tools-0.1.0/src/kes_tools/__main__.py

@@ -0,0 +1,3 @@
+from kes_tools.cli import main
+
+main()

kes_tools-0.1.0/src/kes_tools/auth.py

@@ -0,0 +1,186 @@
+"""Signs in to the kes-tools website through the browser and keeps the refresh token in the OS keychain.
+
+The sign-in is Cognito's authorization-code flow with PKCE: the browser is sent to the hosted sign-in page, which
+redirects to a one-shot HTTP server on localhost with the code. $KES_TOOLS_REFRESH_TOKEN, when set, is used instead
+of the keychain, for machines without a browser or keychain.
+"""
+
+from __future__ import annotations
+
+import base64
+import hashlib
+import json
+import os
+import secrets
+import threading
+import webbrowser
+from http.server import BaseHTTPRequestHandler, HTTPServer
+from urllib.parse import parse_qs, urlencode, urlparse
+
+import httpx
+
+KEYRING_SERVICE = "kes-tools"
+PORTS = (53682, 53683, 53684)
+LOGIN_TIMEOUT = 300
+ENV_TOKEN = "KES_TOOLS_REFRESH_TOKEN"
+
+
+class AuthError(Exception):
+    pass
+
+
+def discover(client: httpx.Client, url: str) -> dict:
+    """The site's Cognito settings from its /config.json."""
+    try:
+        config = client.get(f"{url}/config.json").raise_for_status().json()
+    except (httpx.HTTPError, ValueError) as error:
+        raise AuthError(f"Could not read {url}/config.json: {error}") from None
+    if not config.get("cliClientId") or not config.get("oauthDomain"):
+        raise AuthError(f"{url} does not support the command-line client")
+    return config
+
+
+def pkce() -> tuple[str, str]:
+    verifier = secrets.token_urlsafe(64)
+    challenge = base64.urlsafe_b64encode(hashlib.sha256(verifier.encode()).digest()).decode().rstrip("=")
+    return verifier, challenge
+
+
+def claims(token: str) -> dict:
+    """A JWT's claims, unverified; only used to show who is signed in."""
+    payload = token.split(".")[1]
+    return json.loads(base64.urlsafe_b64decode(payload + "=" * (-len(payload) % 4)))
+
+
+class Redirect(BaseHTTPRequestHandler):
+    result: dict = {}
+
+    def do_GET(self):
+        query = {k: v[0] for k, v in parse_qs(urlparse(self.path).query).items()}
+        if "code" not in query and "error" not in query:
+            self.send_response(404)
+            self.end_headers()
+            return
+        type(self).result.update(query)
+        ok = "code" in query
+        self.send_response(200)
+        self.send_header("content-type", "text/html; charset=utf-8")
+        self.end_headers()
+        message = "You are signed in. You can close this tab." if ok else "Sign-in failed. You can close this tab."
+        self.wfile.write(f"<!doctype html><p style='font-family:sans-serif'>{message}</p>".encode())
+
+    def log_message(self, *args):
+        pass
+
+
+def listen() -> tuple[HTTPServer, int]:
+    for port in PORTS:
+        try:
+            return HTTPServer(("127.0.0.1", port), Redirect), port
+        except OSError:
+            continue
+    raise AuthError(f"Ports {', '.join(map(str, PORTS))} are all in use; close what uses them and try again")
+
+
+def browser_login(client: httpx.Client, config: dict, open_browser=webbrowser.open, notify=print) -> dict:
+    """Runs the browser sign-in and returns Cognito's tokens."""
+    server, port = listen()
+    redirect_uri = f"http://localhost:{port}/"
+    verifier, challenge = pkce()
+    state = secrets.token_urlsafe(16)
+    Redirect.result = {}
+    authorize = f"https://{config['oauthDomain']}/oauth2/authorize?" + urlencode({
+        "response_type": "code", "client_id": config["cliClientId"], "redirect_uri": redirect_uri,
+        "scope": "openid email profile", "state": state, "code_challenge": challenge,
+        "code_challenge_method": "S256",
+    })
+    notify(f"Opening your browser to sign in. If it doesn't open, visit:\n{authorize}")
+    open_browser(authorize)
+    server.timeout = 1
+    stop = threading.Timer(LOGIN_TIMEOUT, lambda: Redirect.result.setdefault("error", "timeout"))
+    stop.start()
+    try:
+        while not Redirect.result:
+            server.handle_request()
+    finally:
+        stop.cancel()
+        server.server_close()
+    result = Redirect.result
+    if result.get("error"):
+        raise AuthError(f"Sign-in failed: {result.get('error_description') or result['error']}")
+    if result.get("state") != state:
+        raise AuthError("Sign-in failed: the reply did not match this sign-in")
+    return token_request(client, config, {"grant_type": "authorization_code", "code": result["code"],
+                                          "redirect_uri": redirect_uri, "code_verifier": verifier})
+
+
+def token_request(client: httpx.Client, config: dict, form: dict) -> dict:
+    response = client.post(f"https://{config['oauthDomain']}/oauth2/token",
+                           data={"client_id": config["cliClientId"], **form})
+    if response.status_code == 400 and response.json().get("error") == "invalid_grant":
+        raise AuthError("Your sign-in has expired or was revoked; run `kes-tools login` again")
+    if response.is_error:
+        raise AuthError(f"Cognito answered HTTP {response.status_code}: {response.text[:200]}")
+    return response.json()
+
+
+def revoke(client: httpx.Client, config: dict, refresh_token: str) -> None:
+    client.post(f"https://{config['oauthDomain']}/oauth2/revoke",
+                data={"client_id": config["cliClientId"], "token": refresh_token})
+
+
+class Store:
+    """The refresh token per site URL, in the OS keychain."""
+
+    def get(self, url: str) -> str | None:
+        if os.environ.get(ENV_TOKEN):
+            return os.environ[ENV_TOKEN]
+        import keyring
+
+        try:
+            return keyring.get_password(KEYRING_SERVICE, url)
+        except keyring.errors.KeyringError as error:
+            raise AuthError(f"Could not read the keychain ({error}); set ${ENV_TOKEN} instead") from None
+
+    def put(self, url: str, token: str) -> None:
+        import keyring
+
+        try:
+            keyring.set_password(KEYRING_SERVICE, url, token)
+        except keyring.errors.KeyringError as error:
+            raise AuthError(f"Could not save to the keychain ({error}); use `kes-tools login --export` and "
+                            f"set ${ENV_TOKEN} instead") from None
+
+    def delete(self, url: str) -> None:
+        import keyring
+
+        try:
+            keyring.delete_password(KEYRING_SERVICE, url)
+        except keyring.errors.PasswordDeleteError:
+            pass
+
+
+class Session:
+    """Access tokens for the site, refreshed from the stored refresh token when needed."""
+
+    def __init__(self, client: httpx.Client, url: str, store: Store | None = None):
+        self.client, self.url, self.store = client, url, store or Store()
+        self.config, self.tokens = None, None
+
+    def settings(self) -> dict:
+        if self.config is None:
+            self.config = discover(self.client, self.url)
+        return self.config
+
+    def access_token(self) -> str:
+        if self.tokens is None:
+            refresh = self.store.get(self.url)
+            if not refresh:
+                raise AuthError("Not signed in; run `kes-tools login` first")
+            self.tokens = token_request(self.client, self.settings(),
+                                        {"grant_type": "refresh_token", "refresh_token": refresh})
+        return self.tokens["access_token"]
+
+    def email(self) -> str | None:
+        self.access_token()
+        return claims(self.tokens["id_token"]).get("email") if self.tokens.get("id_token") else None