cmem-plugin-s3 1.0.0__tar.gz

cmem_plugin_s3-1.0.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 eccenca GmbH
+
+   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.

cmem_plugin_s3-1.0.0/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.4
+Name: cmem-plugin-s3
+Version: 1.0.0
+Summary: List, download and upload files in S3 and S3-compatible object storage.
+License: Apache-2.0
+License-File: LICENSE
+Keywords: eccenca Corporate Memory,plugin
+Author: eccenca GmbH
+Author-email: cmempy-developer@eccenca.com
+Requires-Python: >=3.13,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Plugins
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Dist: boto3 (>=1.40,<2.0)
+Requires-Dist: botocore (>=1.40,<2.0)
+Requires-Dist: cmem-plugin-base (>=4.20.0,<5.0.0)
+Description-Content-Type: text/markdown
+
+# cmem-plugin-s3
+
+List, download and upload files in S3 and S3-compatible object storage.
+
+[![eccenca Corporate Memory][cmem-shield]][cmem-link]
+
+This is a plugin for [eccenca Corporate Memory](https://documentation.eccenca.com). You can install it with the [cmemc](https://eccenca.com/go/cmemc) command line client like this:
+
+```
+cmemc admin workspace python install cmem-plugin-s3
+```
+ [![pypi version](https://img.shields.io/pypi/v/cmem-plugin-s3)](https://pypi.org/project/cmem-plugin-s3) [![license](https://img.shields.io/pypi/l/cmem-plugin-s3)](https://pypi.org/project/cmem-plugin-s3)
+[![poetry][poetry-shield]][poetry-link] [![ruff][ruff-shield]][ruff-link] [![mypy][mypy-shield]][mypy-link] [![copier][copier-shield]][copier] 
+
+[cmem-link]: https://documentation.eccenca.com
+[cmem-shield]: https://img.shields.io/endpoint?url=https://documentation.eccenca.com/latest/badge.json
+[poetry-link]: https://python-poetry.org/
+[poetry-shield]: https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json
+[ruff-link]: https://docs.astral.sh/ruff/
+[ruff-shield]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&label=Code%20Style
+[mypy-link]: https://mypy-lang.org/
+[mypy-shield]: https://www.mypy-lang.org/static/mypy_badge.svg
+[copier]: https://copier.readthedocs.io/
+[copier-shield]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-purple.json
+
+

cmem_plugin_s3-1.0.0/README-public.md

@@ -0,0 +1,25 @@
+# cmem-plugin-s3
+
+List, download and upload files in S3 and S3-compatible object storage.
+
+[![eccenca Corporate Memory][cmem-shield]][cmem-link]
+
+This is a plugin for [eccenca Corporate Memory](https://documentation.eccenca.com). You can install it with the [cmemc](https://eccenca.com/go/cmemc) command line client like this:
+
+```
+cmemc admin workspace python install cmem-plugin-s3
+```
+ [![pypi version](https://img.shields.io/pypi/v/cmem-plugin-s3)](https://pypi.org/project/cmem-plugin-s3) [![license](https://img.shields.io/pypi/l/cmem-plugin-s3)](https://pypi.org/project/cmem-plugin-s3)
+[![poetry][poetry-shield]][poetry-link] [![ruff][ruff-shield]][ruff-link] [![mypy][mypy-shield]][mypy-link] [![copier][copier-shield]][copier] 
+
+[cmem-link]: https://documentation.eccenca.com
+[cmem-shield]: https://img.shields.io/endpoint?url=https://documentation.eccenca.com/latest/badge.json
+[poetry-link]: https://python-poetry.org/
+[poetry-shield]: https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json
+[ruff-link]: https://docs.astral.sh/ruff/
+[ruff-shield]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&label=Code%20Style
+[mypy-link]: https://mypy-lang.org/
+[mypy-shield]: https://www.mypy-lang.org/static/mypy_badge.svg
+[copier]: https://copier.readthedocs.io/
+[copier-shield]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-purple.json
+

cmem_plugin_s3-1.0.0/cmem_plugin_s3/__init__.py

@@ -0,0 +1 @@
+"""cmem-plugin-s3"""

cmem_plugin_s3-1.0.0/cmem_plugin_s3/autocomplete.py

@@ -0,0 +1,130 @@
+"""Parameter types that ask the service what it holds"""
+
+from typing import Any, ClassVar
+
+from cmem_plugin_base.dataintegration.context import PluginContext
+from cmem_plugin_base.dataintegration.parameter.password import Password
+from cmem_plugin_base.dataintegration.types import Autocompletion, StringParameterType
+
+from cmem_plugin_s3.client import S3Client, S3Error, S3Settings
+
+CONNECTION_PARAMETERS: list[str] = [
+    "endpoint_url",
+    "region",
+    "credentials",
+    "access_key_id",
+    "secret_access_key",
+]
+"""The parameters an autocompletion needs before it can reach the service.
+
+Kept to the five that decide where to connect and as whom. The advanced
+connection parameters are deliberately left out: every entry here is a field
+the user has to fill before any list appears, and their defaults are right
+almost always.
+"""
+
+
+def _as_string(value: object) -> str:
+    """Read a parameter value that may arrive as a password."""
+    if isinstance(value, Password):
+        return str(value.decrypt())
+    return "" if value is None else str(value)
+
+
+def _client(values: list[Any]) -> S3Client:
+    """Build a client from the parameter values an autocompletion depends on.
+
+    The connection itself is opened by the first call that needs it, and an
+    endpoint or a credential the user has not finished typing raises there -
+    which is why every caller treats an S3Error as "nothing to offer yet".
+    """
+    endpoint_url, region, credentials, access_key_id, secret_access_key = (
+        _as_string(value) for value in values
+    )
+    settings = S3Settings(
+        endpoint_url=endpoint_url,
+        region=region,
+        credentials=credentials,
+        access_key_id=access_key_id,
+        secret_access_key=secret_access_key,
+    )
+    return S3Client(settings)
+
+
+def _matching(completions: list[Autocompletion], query_terms: list[str]) -> list[Autocompletion]:
+    """Keep the completions that match every term the user typed."""
+    if not query_terms:
+        return completions
+    return [
+        completion
+        for completion in completions
+        if all(
+            term.lower() in (completion.label or completion.value).lower() for term in query_terms
+        )
+    ]
+
+
+class BucketParameterType(StringParameterType):
+    """Offers the buckets the credentials may see
+
+    Any bucket name may still be typed by hand. Listing buckets needs a
+    permission a key scoped to a single bucket does not have, and that key is
+    the well configured case rather than the broken one.
+    """
+
+    allow_only_autocompleted_values: bool = False
+    autocomplete_value_with_labels: bool = False
+    autocompletion_depends_on_parameters: ClassVar[list[str]] = CONNECTION_PARAMETERS
+
+    def autocomplete(
+        self,
+        query_terms: list[str],
+        depend_on_parameter_values: list[Any],
+        context: PluginContext,
+    ) -> list[Autocompletion]:
+        """Return the buckets matching all query terms."""
+        _ = context
+        try:
+            buckets = _client(depend_on_parameter_values).buckets()
+        except S3Error:
+            return []
+        return _matching([Autocompletion(value=name, label=name) for name in buckets], query_terms)
+
+
+class PrefixParameterType(StringParameterType):
+    """Offers the key prefixes of the selected bucket, one level at a time
+
+    What is offered are the prefixes directly below what is typed, so a prefix
+    is assembled by selecting its parts in turn rather than by searching the
+    whole key space - a bucket holds far too many keys for the latter.
+    """
+
+    allow_only_autocompleted_values: bool = False
+    autocomplete_value_with_labels: bool = False
+    autocompletion_depends_on_parameters: ClassVar[list[str]] = [
+        *CONNECTION_PARAMETERS,
+        "bucket",
+    ]
+
+    def autocomplete(
+        self,
+        query_terms: list[str],
+        depend_on_parameter_values: list[Any],
+        context: PluginContext,
+    ) -> list[Autocompletion]:
+        """Return the prefixes below the one that is typed."""
+        _ = context
+        *connection, bucket = depend_on_parameter_values
+        bucket = _as_string(bucket).strip()
+        if not bucket:
+            return []
+        typed = " ".join(query_terms).strip()
+        below = typed[: typed.rindex("/") + 1] if "/" in typed else ""
+        try:
+            prefixes = _client(connection).prefixes(bucket, below)
+        except S3Error:
+            return []
+        completions = [Autocompletion(value=prefix, label=prefix) for prefix in prefixes]
+        if not typed:
+            return completions
+        return [completion for completion in completions if completion.value.startswith(typed)]