cs3client 0.0.1__tar.gz

cs3client-0.0.1/LICENSE

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

cs3client-0.0.1/PKG-INFO

@@ -0,0 +1,368 @@
+Metadata-Version: 2.1
+Name: cs3client
+Version: 0.0.1
+Summary: CS3 client for Python
+Home-page: https://github.com/cs3org/cs3-python-client
+Author: Rasmus Welander, Diogo Castro, Giuseppe Lo Presti
+License: Apache 2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: grpcio>=1.47.0
+Requires-Dist: grpcio-tools>=1.47.0
+Requires-Dist: pyOpenSSL
+Requires-Dist: requests
+Requires-Dist: cs3apis
+Requires-Dist: PyJWT
+Requires-Dist: protobuf
+Requires-Dist: cryptography
+
+# CS3Client
+
+`CS3Client` is a Python client for interacting with the CS3 (Cloud Storage Services for Science) API. It allows users to seamlessly communicate with cloud storage services that support CS3 protocols, enabling file management, data transfer, and other cloud-based operations.
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Configuration](#configuration)
+- [Examples](#examples)
+- [Documentation](#documentation)
+- [License](#license)
+
+
+## Features
+
+- Simple and easy-to-use API client for CS3 services.
+- Support for common file operations (read, write, delete, rename, ...).
+- Support for common lock operations (set lock, get lock, unlock, ...).
+- Support for common share operations (create share, update share, delete share, ...).
+- Support for common user operations (get user, find users, get user groups, ...).
+- Support for restoring files through checkpoints (restore file version, list checkpoints).
+- Support for applications (open in app, list app providers).
+- Authentication and authorization handling.
+- Cross-platform compatibility.
+- Detailed error handling and logging.
+
+## Installation
+
+To install `cs3client`, you need to have Python 3.7+ installed. You can install the package via `pip`:
+
+```bash
+pip install cs3client
+```
+Alternatively, you can clone this repository and install manually:
+```bash
+git clone git@github.com:cs3org/cs3-python-client.git
+cd cs3-python-client
+pip install . 
+```
+
+
+## Configuration
+
+`CS3Client` can be configured by passing specific parameters when initializing the client through a ConfigParser instance.
+
+### Parameters:
+
+#### Required
+- `host`
+
+#### Optional (parameter - default)
+- `chunk_size` - 4194384
+- `grpc_timeout` - 10
+- `http_timeout` - 10
+- `tus_enabled` - False
+- `ssl_enabled` - False
+- `ssl_client_cert` - None
+- `ssl_client_key` - None
+- `ssl_ca_cert` - None
+- `auth_client_id` - None
+- `auth_login_type` - "basic"
+- `lock_by_setting_attr` - False
+- `lock_not_impl` - False
+- `lock_expiration` - 1800
+
+#### Example configuration
+```yaml
+[cs3client]
+
+# Required
+host = localhost:19000
+# Optional, defaults to 4194304
+chunk_size = 4194304
+# Optional, defaults to 10
+grpc_timeout = 10
+# Optional, defaults to 10
+http_timeout = 10
+
+# Optional, defaults to True
+tus_enabled = False
+
+# Optional, defaults to True
+ssl_enabled = False
+# Optional, defaults to True
+ssl_verify = False
+# Optional, defaults to an empty string
+ssl_client_cert = test_client_cert
+# Optional, defaults to an empty string
+ssl_client_key = test_client_key
+# Optional, defaults to an empty string
+ssl_ca_cert = test_ca_cert
+
+# Optinal, defaults to an empty string
+auth_client_id = einstein
+# Optional (can also be set when instansiating the class)
+auth_client_secret = relativity
+# Optional, defaults to basic
+auth_login_type = basic
+
+# Optional, defaults to False
+lock_by_setting_attr = False
+# Optional, defaults to False
+lock_not_impl = False
+# Optional, defaults to 1800
+lock_expiration = 1800
+
+
+```
+
+## Usage
+
+To use `cs3client`, you first need to import and configure it. Here's a simple example of how to set up and start using the client. For configuration see [Configuration](#configuration). For more in depth examples see `cs3-python-client/examples/`. 
+
+### Initilization and Authentication
+```python
+import logging
+import configparser
+from cs3client.cs3client import CS3Client
+from cs3client.auth import Auth
+
+config = configparser.ConfigParser()
+with open("default.conf") as fdef:
+    config.read_file(fdef)
+log = logging.getLogger(__name__)
+
+client = CS3Client(config, "cs3client", log)
+auth = Auth(client)
+# Set the client id (can also be set in the config)
+auth.set_client_id("<your_client_id_here>")
+# Set client secret (can also be set in config)
+auth.set_client_secret("<your_client_secret_here>")
+# Checks if token is expired if not return ('x-access-token', <token>)
+# if expired, request a new token from reva
+auth_token = auth.get_token()
+
+# OR if you already have a reva token
+# Checks if token is expired if not return (x-access-token', <token>)
+# if expired, throws an AuthenticationException (so you can refresh your reva token)
+token = "<your_reva_token>"
+auth_token = Auth.check_token(token)
+
+```
+
+### File Example
+```python
+# mkdir
+directory_resource = Resource(abs_path=f"/eos/user/r/rwelande/test_directory")
+res = client.file.make_dir(auth.get_token(), directory_resource)
+
+# touchfile
+touch_resource = Resource(abs_path="/eos/user/r/rwelande/touch_file.txt")
+res = client.file.touch_file(auth.get_token(), touch_resource)
+
+# setxattr
+resource = Resource(abs_path="/eos/user/r/rwelande/text_file.txt")
+res = client.file.set_xattr(auth.get_token(), resource, "iop.wopi.lastwritetime", str(1720696124))
+
+# rmxattr
+res = client.file.remove_xattr(auth.get_token(), resource, "iop.wopi.lastwritetime")
+
+# stat
+res = client.file.stat(auth.get_token(), resource)
+
+# removefile
+res = client.file.remove_file(auth.get_token(), touch_resource)
+
+# rename
+rename_resource = Resource(abs_path="/eos/user/r/rwelande/rename_file.txt")
+res = client.file.rename_file(auth.get_token(), resource, rename_resource)
+
+# writefile
+content = b"Hello World"
+size = len(content)
+res = client.file.write_file(auth.get_token(), rename_resource, content, size)
+
+# listdir
+list_directory_resource = Resource(abs_path="/eos/user/r/rwelande")
+res = client.file.list_dir(auth.get_token(), list_directory_resource)
+
+
+# readfile
+file_res = client.file.read_file(auth.get_token(), rename_resource)
+```
+### Lock Example
+```python
+
+WEBDAV_LOCK_PREFIX = 'opaquelocktoken:797356a8-0500-4ceb-a8a0-c94c8cde7eba'
+
+
+def encode_lock(lock):
+    '''Generates the lock payload for the storage given the raw metadata'''
+    if lock:
+        return WEBDAV_LOCK_PREFIX + ' ' + b64encode(lock.encode()).decode()
+    return None
+
+resource = Resource(abs_path="/eos/user/r/rwelande/lock_test.txt")
+
+# Set lock
+client.file.set_lock(auth_token, resource, app_name="a", lock_id=encode_lock("some_lock"))
+
+# Get lock
+res = client.file.get_lock(auth_token, resource)
+if res is not None:
+    lock_id = res["lock_id"]
+    print(res)
+
+# Unlock
+res = client.file.unlock(auth_token, resource, app_name="a", lock_id=lock_id)
+
+# Refresh lock
+client.file.set_lock(auth_token, resource, app_name="a", lock_id=encode_lock("some_lock"))
+res = client.file.refresh_lock(
+    auth_token, resource, app_name="a", lock_id=encode_lock("new_lock"), existing_lock_id=lock_id
+)
+
+if res is not None:
+    print(res)
+
+res = client.file.get_lock(auth_token, resource)
+if res is not None:
+    print(res)
+
+```
+
+### Share Example
+```python
+# Create share #
+resource = Resource(abs_path="/eos/user/r/<some_username>/text.txt")
+resource_info = client.file.stat(auth.get_token(), resource)
+user = client.user.get_user_by_claim("username", "<some_username>")
+res = client.share.create_share(auth.get_token(), resource_info, user.id.opaque_id, user.id.idp, "EDITOR", "USER")
+
+# List existing shares #
+filter_list = []
+filter = client.share.create_share_filter(resource_id=resource_info.id, filter_type="TYPE_RESOURCE_ID")
+filter_list.append(filter)
+filter = client.share.create_share_filter(share_state="SHARE_STATE_PENDING", filter_type="TYPE_STATE")
+filter_list.append(filter)
+res, _ = client.share.list_existing_shares(auth.get_token(), )
+
+# Get share #
+share_id = "58"
+res = client.share.get_share(auth.get_token(), opaque_id=share_id)
+
+# update share #
+res = client.share.update_share(auth.get_token(), opaque_id=share_id, role="VIEWER")
+
+# remove share #
+res = client.share.remove_share(auth.get_token(), opaque_id=share_id)
+
+# List existing received shares #
+filter_list = []
+filter = client.share.create_share_filter(share_state="SHARE_STATE_ACCEPTED", filter_type="TYPE_STATE")
+filter_list.append(filter)
+res, _ = client.share.list_received_existing_shares(auth.get_token())
+
+# get received share #
+received_share = client.share.get_received_share(auth.get_token(), opaque_id=share_id)
+
+# update recieved share #
+res = client.share.update_received_share(auth.get_token(), received_share=received_share, state="SHARE_STATE_ACCEPTED")
+
+# create public share #
+res = client.share.create_public_share(auth.get_token(), resource_info, role="VIEWER")
+
+# list existing public shares #
+filter_list = []
+filter = client.share.create_public_share_filter(resource_id=resource_info.id, filter_type="TYPE_RESOURCE_ID")
+filter_list.append(filter)
+res, _ = client.share.list_existing_public_shares(filter_list=filter_list)
+
+res = client.share.get_public_share(auth.get_token(), opaque_id=share_id, sign=True)
+# OR token = "<token>"
+# res = client.share.get_public_share(token=token, sign=True)
+
+# update public share #
+res = client.share.update_public_share(auth.get_token(), type="TYPE_PASSWORD", token=token, role="VIEWER", password="hello")
+
+# remove public share #
+res = client.share.remove_public_share(auth.get_token(), token=token)
+
+```
+
+### User Example
+```python
+# find_user
+res = client.user.find_users(auth.get_token(), "rwel")
+
+# get_user
+res = client.user.get_user("https://auth.cern.ch/auth/realms/cern", "asdoiqwe")
+
+# get_user_groups
+res = client.user.get_user_groups("https://auth.cern.ch/auth/realms/cern", "rwelande")
+
+# get_user_by_claim (mail)
+res = client.user.get_user_by_claim("mail", "rasmus.oscar.welander@cern.ch")
+
+# get_user_by_claim (username)
+res = client.user.get_user_by_claim("username", "rwelande")
+
+```
+
+### App Example
+```python
+# list_app_providers
+res = client.app.list_app_providers(auth.get_token())
+
+# open_in_app
+resource = Resource(abs_path="/eos/user/r/rwelande/collabora.odt")
+res = client.app.open_in_app(auth.get_token(), resource)
+```
+
+### Checkpoint Example
+```python
+# list file versions
+resource = Resource(abs_path="/eos/user/r/rwelande/test.md")
+res = client.checkpoint.list_file_versions(auth.get_token(), resource)
+
+# restore file version
+res = client.checkpoint.restore_file_version(auth.get_token(), resource, "1722936250.0569fa2f")
+```
+
+## Documentation
+The documentation can be generated using sphinx
+
+```bash
+pip install sphinx
+cd docs
+make html
+```
+
+## Unit tests
+
+```bash
+pytest --cov-report term --cov=serc tests/
+```
+
+## License
+
+This project is licensed under the Apache 2.0 License. See the LICENSE file for more details.