boto3-s3-cli 0.1.0__tar.gz

boto3_s3_cli-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 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 accept and charge a
+      fee for, or grant warranty, support, indemnity, or other liability
+      obligations and/or rights consistent with this License. However,
+      in accepting such obligations, You may act solely 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 2026 Masanao Izumo
+
+   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.

boto3_s3_cli-0.1.0/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.4
+Name: boto3-s3-cli
+Version: 0.1.0
+Summary: An `aws s3` compatible CLI built on the boto3-s3 library.
+Keywords: aws,s3,cli
+Author: Masanao Izumo
+Author-email: Masanao Izumo <ngc.izumo@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Utilities
+Requires-Dist: boto3-s3>=0.1.0
+Requires-Dist: botocore>=1.31
+Requires-Dist: prompt-toolkit>=3.0 ; extra == 'autoprompt'
+Requires-Dist: boto3-s3[crt] ; extra == 'crt'
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/izumo-m/boto3-s3
+Project-URL: Repository, https://github.com/izumo-m/boto3-s3
+Project-URL: Documentation, https://github.com/izumo-m/boto3-s3/blob/main/cli/README.md
+Project-URL: Issues, https://github.com/izumo-m/boto3-s3/issues
+Provides-Extra: autoprompt
+Provides-Extra: crt
+Description-Content-Type: text/markdown
+
+# boto3-s3-cli
+
+An `aws s3`-compatible command line, built on the
+[`boto3-s3`](https://pypi.org/project/boto3-s3/) library.
+
+```bash
+pip install boto3-s3-cli
+boto3-s3 sync ./build s3://my-bucket/build/ --delete
+```
+
+**Status:** early development (pre-1.0). **Python:** 3.10+ · **License:** Apache-2.0
+
+## What it is
+
+`boto3-s3-cli` installs one command, **`boto3-s3`**, a drop-in for `aws s3` with
+every subcommand:
+
+```
+cp   ls   mb   mv   presign   rb   rm   sync   website
+```
+
+It takes the same arguments and global options as `aws s3`, reads the same
+`~/.aws` configuration, and returns the same exit codes — so existing commands
+and scripts keep working: just swap `aws s3` for `boto3-s3`. Argument handling,
+configuration, and exit codes are tested for parity with `aws s3`.
+
+## Footprint & startup
+
+`boto3-s3-cli` is an ordinary Python package: it runs on the interpreter you
+already have and reuses your boto3 / botocore install rather than bundling its
+own. aws-cli v2 ships as a self-contained install — its own embedded Python plus a
+private copy of the SDK — and pays that bootstrap on every invocation.
+
+The startup gap is large. Against a local MinIO, listing a missing bucket (so the
+request itself is negligible) and printing `--version`, on one Linux machine:
+
+| Command                  | aws-cli v2 | boto3-s3-cli |
+| ------------------------ | ---------- | ------------ |
+| `ls` of a missing bucket | ~670 ms    | ~250 ms      |
+| `--version`              | ~580 ms    | ~65 ms       |
+
+Same result, same exit code — boto3-s3-cli just skips the bundle's bootstrap and
+lazy-loads only what the subcommand needs. (Figures are from one environment and
+will vary; the ratio is what's representative.)
+
+## Install
+
+```bash
+pip install boto3-s3-cli
+```
+
+Optional extras:
+
+```bash
+pip install "boto3-s3-cli[crt]"          # AWS Common Runtime transfer engine + CRT checksums
+pip install "boto3-s3-cli[autoprompt]"   # --cli-auto-prompt interactive completion
+```
+
+With the autoprompt extra, run `boto3-s3 --cli-auto-prompt` to complete
+arguments interactively as you type.
+
+## Examples
+
+```bash
+# Copy (upload / download / S3-to-S3 — the route is inferred from the paths)
+boto3-s3 cp ./report.csv s3://my-bucket/report.csv
+boto3-s3 cp s3://my-bucket/report.csv ./report.csv
+boto3-s3 cp ./build s3://my-bucket/build/ --recursive
+
+# Sync a prefix onto disk, deleting local extras
+boto3-s3 sync s3://my-bucket/site/ ./site --delete
+
+# Include / exclude (last match wins)
+boto3-s3 cp ./build s3://artifacts/ --recursive --exclude '*' --include '*.tar.gz'
+
+# Preview without touching anything
+boto3-s3 sync ./data s3://my-bucket/data/ --dryrun
+
+# List
+boto3-s3 ls s3://my-bucket/build/ --recursive --human-readable --summarize
+
+# Delete everything under a prefix
+boto3-s3 rm s3://my-bucket/tmp/ --recursive
+
+# Buckets, a presigned URL, a static-site config
+boto3-s3 mb s3://my-new-bucket
+boto3-s3 presign s3://my-bucket/report.csv --expires-in 900
+boto3-s3 website s3://my-bucket --index-document index.html
+```
+
+Streaming works through `-`, like `aws s3 cp`: `boto3-s3 cp - s3://b/key`
+uploads stdin, and `boto3-s3 cp s3://b/key -` writes the object to stdout.
+
+## Configuration
+
+Credentials and connection settings come from the standard AWS sources, selected
+with the same global flags as `aws s3` — `--profile`, `--region`,
+`--endpoint-url` (e.g. for MinIO), `--no-sign-request`, `--no-verify-ssl`,
+`--ca-bundle`, and the timeout flags. A global flag may appear **before or
+after** the subcommand:
+
+```bash
+boto3-s3 --profile prod --region eu-west-1 ls s3://my-bucket
+boto3-s3 ls s3://my-bucket --profile prod --region eu-west-1
+```
+
+Transfer tuning is read from the profile's `[s3]` section in `~/.aws/config`
+(`max_concurrent_requests`, `multipart_threshold`, `multipart_chunksize`,
+`max_queue_size`, `max_bandwidth`, `io_chunksize`, `preferred_transfer_client`),
+exactly as `aws s3` reads it.
+
+`--debug` turns on wire-level logging with credentials (signatures, access-key
+ids, session tokens) masked by default.
+
+Run `boto3-s3 <command> --help` for a subcommand's full option list.
+
+## Exit codes
+
+For scripting, `boto3-s3` returns the same codes as `aws s3`:
+
+| Code | Meaning |
+| --- | --- |
+| `0` | Success. |
+| `1` | A transfer or delete failed, or a lookup matched nothing (e.g. `ls` of a key/prefix that doesn't exist). |
+| `2` | Completed with warnings only (e.g. a skipped Glacier object). |
+| `252` | Usage / argument error. |
+| `253` | Configuration error (credentials, region). |
+| `254` | Server-side error. |
+| `255` | Other general error (e.g. a non-integer value for a numeric option). |
+
+## License
+
+Apache-2.0. See
+[`LICENSE`](https://github.com/izumo-m/boto3-s3/blob/main/LICENSE) in the main
+repository.
+
+Main project (source, issues): <https://github.com/izumo-m/boto3-s3>.

boto3_s3_cli-0.1.0/README.md

@@ -0,0 +1,137 @@
+# boto3-s3-cli
+
+An `aws s3`-compatible command line, built on the
+[`boto3-s3`](https://pypi.org/project/boto3-s3/) library.
+
+```bash
+pip install boto3-s3-cli
+boto3-s3 sync ./build s3://my-bucket/build/ --delete
+```
+
+**Status:** early development (pre-1.0). **Python:** 3.10+ · **License:** Apache-2.0
+
+## What it is
+
+`boto3-s3-cli` installs one command, **`boto3-s3`**, a drop-in for `aws s3` with
+every subcommand:
+
+```
+cp   ls   mb   mv   presign   rb   rm   sync   website
+```
+
+It takes the same arguments and global options as `aws s3`, reads the same
+`~/.aws` configuration, and returns the same exit codes — so existing commands
+and scripts keep working: just swap `aws s3` for `boto3-s3`. Argument handling,
+configuration, and exit codes are tested for parity with `aws s3`.
+
+## Footprint & startup
+
+`boto3-s3-cli` is an ordinary Python package: it runs on the interpreter you
+already have and reuses your boto3 / botocore install rather than bundling its
+own. aws-cli v2 ships as a self-contained install — its own embedded Python plus a
+private copy of the SDK — and pays that bootstrap on every invocation.
+
+The startup gap is large. Against a local MinIO, listing a missing bucket (so the
+request itself is negligible) and printing `--version`, on one Linux machine:
+
+| Command                  | aws-cli v2 | boto3-s3-cli |
+| ------------------------ | ---------- | ------------ |
+| `ls` of a missing bucket | ~670 ms    | ~250 ms      |
+| `--version`              | ~580 ms    | ~65 ms       |
+
+Same result, same exit code — boto3-s3-cli just skips the bundle's bootstrap and
+lazy-loads only what the subcommand needs. (Figures are from one environment and
+will vary; the ratio is what's representative.)
+
+## Install
+
+```bash
+pip install boto3-s3-cli
+```
+
+Optional extras:
+
+```bash
+pip install "boto3-s3-cli[crt]"          # AWS Common Runtime transfer engine + CRT checksums
+pip install "boto3-s3-cli[autoprompt]"   # --cli-auto-prompt interactive completion
+```
+
+With the autoprompt extra, run `boto3-s3 --cli-auto-prompt` to complete
+arguments interactively as you type.
+
+## Examples
+
+```bash
+# Copy (upload / download / S3-to-S3 — the route is inferred from the paths)
+boto3-s3 cp ./report.csv s3://my-bucket/report.csv
+boto3-s3 cp s3://my-bucket/report.csv ./report.csv
+boto3-s3 cp ./build s3://my-bucket/build/ --recursive
+
+# Sync a prefix onto disk, deleting local extras
+boto3-s3 sync s3://my-bucket/site/ ./site --delete
+
+# Include / exclude (last match wins)
+boto3-s3 cp ./build s3://artifacts/ --recursive --exclude '*' --include '*.tar.gz'
+
+# Preview without touching anything
+boto3-s3 sync ./data s3://my-bucket/data/ --dryrun
+
+# List
+boto3-s3 ls s3://my-bucket/build/ --recursive --human-readable --summarize
+
+# Delete everything under a prefix
+boto3-s3 rm s3://my-bucket/tmp/ --recursive
+
+# Buckets, a presigned URL, a static-site config
+boto3-s3 mb s3://my-new-bucket
+boto3-s3 presign s3://my-bucket/report.csv --expires-in 900
+boto3-s3 website s3://my-bucket --index-document index.html
+```
+
+Streaming works through `-`, like `aws s3 cp`: `boto3-s3 cp - s3://b/key`
+uploads stdin, and `boto3-s3 cp s3://b/key -` writes the object to stdout.
+
+## Configuration
+
+Credentials and connection settings come from the standard AWS sources, selected
+with the same global flags as `aws s3` — `--profile`, `--region`,
+`--endpoint-url` (e.g. for MinIO), `--no-sign-request`, `--no-verify-ssl`,
+`--ca-bundle`, and the timeout flags. A global flag may appear **before or
+after** the subcommand:
+
+```bash
+boto3-s3 --profile prod --region eu-west-1 ls s3://my-bucket
+boto3-s3 ls s3://my-bucket --profile prod --region eu-west-1
+```
+
+Transfer tuning is read from the profile's `[s3]` section in `~/.aws/config`
+(`max_concurrent_requests`, `multipart_threshold`, `multipart_chunksize`,
+`max_queue_size`, `max_bandwidth`, `io_chunksize`, `preferred_transfer_client`),
+exactly as `aws s3` reads it.
+
+`--debug` turns on wire-level logging with credentials (signatures, access-key
+ids, session tokens) masked by default.
+
+Run `boto3-s3 <command> --help` for a subcommand's full option list.
+
+## Exit codes
+
+For scripting, `boto3-s3` returns the same codes as `aws s3`:
+
+| Code | Meaning |
+| --- | --- |
+| `0` | Success. |
+| `1` | A transfer or delete failed, or a lookup matched nothing (e.g. `ls` of a key/prefix that doesn't exist). |
+| `2` | Completed with warnings only (e.g. a skipped Glacier object). |
+| `252` | Usage / argument error. |
+| `253` | Configuration error (credentials, region). |
+| `254` | Server-side error. |
+| `255` | Other general error (e.g. a non-integer value for a numeric option). |
+
+## License
+
+Apache-2.0. See
+[`LICENSE`](https://github.com/izumo-m/boto3-s3/blob/main/LICENSE) in the main
+repository.
+
+Main project (source, issues): <https://github.com/izumo-m/boto3-s3>.

boto3_s3_cli-0.1.0/pyproject.toml

@@ -0,0 +1,49 @@
+[project]
+name = "boto3-s3-cli"
+version = "0.1.0"
+description = "An `aws s3` compatible CLI built on the boto3-s3 library."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Masanao Izumo", email = "ngc.izumo@gmail.com" },
+]
+keywords = ["aws", "s3", "cli"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Utilities",
+]
+dependencies = [
+    # Released in lockstep; floor pins the library version this CLI is built against.
+    "boto3-s3>=0.1.0",
+    # Imported directly by build_client (Config / UNSIGNED / signer pin); floor matches boto3-s3's boto3 pin.
+    "botocore>=1.31",
+]
+
+[project.optional-dependencies]
+# Opt-in CRT support, forwarding down the stack to boto3-s3[crt] (see docs/crt.md).
+crt = ["boto3-s3[crt]"]
+# Opt-in --cli-auto-prompt interactive UI via prompt_toolkit (see docs/autoprompt.md).
+autoprompt = ["prompt_toolkit>=3.0"]
+
+[project.scripts]
+boto3-s3 = "boto3_s3_cli.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/izumo-m/boto3-s3"
+Repository = "https://github.com/izumo-m/boto3-s3"
+Documentation = "https://github.com/izumo-m/boto3-s3/blob/main/cli/README.md"
+Issues = "https://github.com/izumo-m/boto3-s3/issues"
+
+[build-system]
+requires = ["uv_build>=0.11.14,<0.12.0"]
+build-backend = "uv_build"
+
+[tool.uv.sources]
+boto3-s3 = { workspace = true }

boto3_s3_cli-0.1.0/src/boto3_s3_cli/__init__.py

@@ -0,0 +1,26 @@
+"""boto3-s3-cli - `aws s3` compatible CLI built on the boto3-s3 library."""
+
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    __version__: str
+
+__all__ = ["__version__"]
+
+
+def __getattr__(name: str) -> Any:
+    """Resolve ``__version__`` on first access (PEP 562).
+
+    importlib.metadata costs ~20ms to import; deferring it keeps that off
+    every CLI start (import contract, docs/imports.md).
+    """
+    if name == "__version__":
+        from importlib.metadata import PackageNotFoundError, version
+
+        try:
+            value = version("boto3-s3-cli")
+        except PackageNotFoundError:  # pragma: no cover - only from an unbuilt checkout
+            value = "0.0.0+unknown"
+        globals()[name] = value
+        return value
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

boto3_s3_cli-0.1.0/src/boto3_s3_cli/autoprompt/__init__.py

@@ -0,0 +1,19 @@
+"""Auto-prompt (``--cli-auto-prompt``) support: an interactive prompt with
+``aws s3``-faithful completion, active only when ``prompt_toolkit`` is installed.
+
+This package is imported lazily - only once ``--cli-auto-prompt`` actually fires
+on an install that has the ``autoprompt`` extra (``prompt_toolkit``). Nothing
+here is touched on the ``--help`` / ``--version`` / usage / normal-dispatch
+paths (import contract, ``docs/imports.md``).
+
+The completion engine (:mod:`model`, :mod:`parser`, :mod:`completers`) is a
+port of aws-cli's ``awscli/autocomplete/`` scoped to the ``boto3-s3`` command
+surface, and is pure Python (no ``prompt_toolkit``). Only :mod:`prompt` binds
+``prompt_toolkit``. Design: ``docs/autoprompt.md``.
+"""
+
+from __future__ import annotations
+
+from boto3_s3_cli.autoprompt.prompter import AutoPrompter
+
+__all__ = ["AutoPrompter"]