Updated project structure

Author: Rasmus Oscar Welander

.gitignore

@@ -157,6 +157,9 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
+# MacOS
+.DS_Store
+
 # PyCharm
 #  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore

src/__init__.py renamed to cs3client/__init__.py

@@ -13,9 +13,9 @@
 import cs3.app.provider.v1beta1.resources_pb2 as cs3apr
 from cs3.gateway.v1beta1.gateway_api_pb2_grpc import GatewayAPIStub
 
-from cs3resource import Resource
-from statuscodehandler import StatusCodeHandler
-from config import Config
+from .cs3resource import Resource
+from .statuscodehandler import StatusCodeHandler
+from .config import Config
 
 
 class App:

src/app.py renamed to cs3client/app.py

@@ -15,9 +15,9 @@
 from cs3.gateway.v1beta1.gateway_api_pb2_grpc import GatewayAPIStub
 from cs3.rpc.v1beta1.code_pb2 import CODE_OK
 
-from cs3client import CS3Client
-from exceptions.exceptions import AuthenticationException, SecretNotSetException
-from config import Config
+from .cs3client import CS3Client
+from .exceptions.exceptions import AuthenticationException, SecretNotSetException
+from .config import Config
 
 
 class Auth:

src/auth.py renamed to cs3client/auth.py

@@ -12,9 +12,9 @@
 import cs3.storage.provider.v1beta1.provider_api_pb2 as cs3spp
 from cs3.gateway.v1beta1.gateway_api_pb2_grpc import GatewayAPIStub
 
-from config import Config
-from statuscodehandler import StatusCodeHandler
-from cs3resource import Resource
+from .config import Config
+from .statuscodehandler import StatusCodeHandler
+from .cs3resource import Resource
 
 
 class Checkpoint:

src/checkpoint.py renamed to cs3client/checkpoint.py

@@ -11,13 +11,13 @@
 import cs3.gateway.v1beta1.gateway_api_pb2_grpc as cs3gw_grpc
 from configparser import ConfigParser
 
-from file import File
-from user import User
-from share import Share
-from statuscodehandler import StatusCodeHandler
-from app import App
-from checkpoint import Checkpoint
-from config import Config
+from .file import File
+from .user import User
+from .share import Share
+from .statuscodehandler import StatusCodeHandler
+from .app import App
+from .checkpoint import Checkpoint
+from .config import Config
 
 
 class CS3Client:

src/config.py renamed to cs3client/config.py

@@ -3,7 +3,7 @@
 
 Authors: Rasmus Welander, Diogo Castro, Giuseppe Lo Presti.
 Emails: [email protected], [email protected], [email protected]
-Last updated: 29/08/2024
+Last updated: 30/08/2024
 """
 
 import time
@@ -16,10 +16,10 @@
 from cs3.gateway.v1beta1.gateway_api_pb2_grpc import GatewayAPIStub
 import cs3.types.v1beta1.types_pb2 as types
 
-from config import Config
-from exceptions.exceptions import AuthenticationException, FileLockedException
-from cs3resource import Resource
-from statuscodehandler import StatusCodeHandler
+from .config import Config
+from .exceptions.exceptions import AuthenticationException, FileLockedException
+from .cs3resource import Resource
+from .statuscodehandler import StatusCodeHandler
 
 
 class File:

src/cs3client.py renamed to cs3client/cs3client.py

@@ -18,9 +18,9 @@
 import google.protobuf.field_mask_pb2 as field_masks
 import cs3.types.v1beta1.types_pb2 as cs3types
 
-from cs3resource import Resource
-from config import Config
-from statuscodehandler import StatusCodeHandler
+from .cs3resource import Resource
+from .config import Config
+from .statuscodehandler import StatusCodeHandler
 
 
 class Share:

src/cs3resource.py renamed to cs3client/cs3resource.py

@@ -10,9 +10,9 @@
 import cs3.rpc.v1beta1.code_pb2 as cs3code
 import cs3.rpc.v1beta1.status_pb2 as cs3status
 
-from exceptions.exceptions import AuthenticationException, NotFoundException, \
+from .exceptions.exceptions import AuthenticationException, NotFoundException, \
     UnknownException, AlreadyExistsException, FileLockedException, UnimplementedException
-from config import Config
+from .config import Config
 
 
 class StatusCodeHandler:

src/exceptions/__init__.py renamed to cs3client/exceptions/__init__.py

@@ -11,8 +11,8 @@
 import cs3.identity.user.v1beta1.user_api_pb2 as cs3iu
 from cs3.gateway.v1beta1.gateway_api_pb2_grpc import GatewayAPIStub
 
-from config import Config
-from statuscodehandler import StatusCodeHandler
+from .config import Config
+from .statuscodehandler import StatusCodeHandler
 
 
 class User:

src/exceptions/exceptions.py renamed to cs3client/exceptions/exceptions.py

@@ -11,9 +11,9 @@
 
 import logging
 import configparser
-from cs3resource import Resource
-from cs3client import CS3Client
-from auth import Auth
+from cs3client.cs3resource import Resource
+from cs3client.cs3client import CS3Client
+from cs3client.auth import Auth
 
 config = configparser.ConfigParser()
 with open("default.conf") as fdef:

src/file.py renamed to cs3client/file.py

@@ -11,8 +11,8 @@
 
 import logging
 import configparser
-from cs3client import CS3Client
-from auth import Auth
+from cs3client.cs3client import CS3Client
+from cs3client.auth import Auth
 
 config = configparser.ConfigParser()
 with open("default.conf") as fdef:

src/share.py renamed to cs3client/share.py

@@ -11,9 +11,9 @@
 
 import logging
 import configparser
-from cs3resource import Resource
-from cs3client import CS3Client
-from auth import Auth
+from cs3client.cs3resource import Resource
+from cs3client.cs3client import CS3Client
+from cs3client.auth import Auth
 
 config = configparser.ConfigParser()
 with open("default.conf") as fdef:

src/statuscodehandler.py renamed to cs3client/statuscodehandler.py

@@ -18,9 +18,9 @@
 
 import logging
 import configparser
-from cs3client import CS3Client
-from cs3resource import Resource
-from auth import Auth
+from cs3client.cs3client import CS3Client
+from cs3client.cs3resource import Resource
+from cs3client.auth import Auth
 
 config = configparser.ConfigParser()
 with open("default.conf") as fdef:

src/user.py renamed to cs3client/user.py

@@ -11,9 +11,9 @@
 
 import logging
 import configparser
-from cs3client import CS3Client
-from cs3resource import Resource
-from auth import Auth
+from cs3client.cs3client import CS3Client
+from cs3client.cs3resource import Resource
+from cs3client.auth import Auth
 
 config = configparser.ConfigParser()
 with open("default.conf") as fdef:

docs/.DS_Store

@@ -11,8 +11,8 @@
 
 import logging
 import configparser
-from cs3client import CS3Client
-from auth import Auth
+from cs3client.cs3client import CS3Client
+from cs3client.auth import Auth
 
 config = configparser.ConfigParser()
 with open("default.conf") as fdef:

examples/app_api_example.py

@@ -5,7 +5,7 @@
 
 Authors: Rasmus Welander, Diogo Castro, Giuseppe Lo Presti.
 Emails: [email protected], [email protected], [email protected]
-Last updated: 26/07/2024
+Last updated: 30/08/2024
 """
 
 from setuptools import setup, find_packages
@@ -20,12 +20,10 @@
     name="cs3client",
     version=version,
     author="Rasmus Welander, Diogo Castro, Giuseppe Lo Presti",
-    package_dir={"": "src"},
-    packages=find_packages(where="src"),
-    py_modules=["cs3client"],
     description="CS3 client for Python",
     long_description=long_description,
     long_description_content_type="text/markdown",
+    packages=find_packages(exclude=['tests*']),
     url="https://github.com/cs3org/cs3-python-client",
     install_requires=[
         "grpcio>=1.47.0",
@@ -37,4 +35,15 @@
         "protobuf",
         "cryptography",
     ],
+    license="Apache 2.0",
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "License :: OSI Approved :: Apache Software License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Operating System :: OS Independent",
+    ],
 )

examples/auth_example.py

@@ -12,19 +12,18 @@
 import pytest
 from unittest.mock import Mock, patch
 from configparser import ConfigParser
-import cs3.rpc.v1beta1.code_pb2 as cs3code
 import base64
 import json
 
-from cs3client import CS3Client
-from file import File
-from auth import Auth
-from user import User
-from statuscodehandler import StatusCodeHandler
-from share import Share
-from app import App
-from checkpoint import Checkpoint
-from config import Config
+from cs3client.cs3client import CS3Client
+from cs3client.file import File
+from cs3client.auth import Auth
+from cs3client.user import User
+from cs3client.statuscodehandler import StatusCodeHandler
+from cs3client.share import Share
+from cs3client.app import App
+from cs3client.checkpoint import Checkpoint
+from cs3client.config import Config
 
 
 @pytest.fixture
@@ -87,13 +86,6 @@ def mock_status_code_handler(mock_logger, mock_config):
 def mock_gateway(mock_gateway_stub_class):
     mock_gateway_stub = Mock()
     mock_gateway_stub_class.return_value = mock_gateway_stub
-    # Set up mock response for Authenticate method
-    mocked_token = create_mock_jwt()
-    mock_authenticate_response = Mock()
-    mock_authenticate_response.status.code = cs3code.CODE_OK
-    mock_authenticate_response.status.message = ""
-    mock_authenticate_response.token = mocked_token
-    mock_gateway_stub.Authenticate.return_value = mock_authenticate_response
     return mock_gateway_stub
 
 
@@ -118,7 +110,6 @@ def cs3_client_secure(
 
     # Create CS3Client instance
     client = CS3Client(mock_config, "cs3client", mock_logger)
-    client.auth.set_client_secret("test")
 
     assert mock_secure_channel.called
     assert mock_channel_ready_future.called
@@ -150,7 +141,6 @@ def cs3_client_insecure(
 
     # Create CS3Client instance
     client = CS3Client(mock_config, "cs3client", mock_logger)
-    client.auth.set_client_secret("test")
 
     assert mock_insecure_channel.called
     assert mock_channel_ready_future.called

examples/checkpoints_api_example.py

@@ -11,13 +11,14 @@
 import cs3.rpc.v1beta1.code_pb2 as cs3code
 from unittest.mock import Mock, patch
 import pytest
-from exceptions.exceptions import (
+
+from cs3client.exceptions.exceptions import (
     AuthenticationException,
     NotFoundException,
     UnknownException,
 )
-from cs3resource import Resource
-from fixtures import (  # noqa: F401 (they are used, the framework is not detecting it)
+from cs3client.cs3resource import Resource
+from .fixtures import (  # noqa: F401 (they are used, the framework is not detecting it)
     mock_config,
     mock_logger,
     mock_gateway,

examples/file_api_example.py

@@ -11,13 +11,14 @@
 from unittest.mock import Mock, patch
 import pytest
 import cs3.rpc.v1beta1.code_pb2 as cs3code
-from exceptions.exceptions import (
+
+from cs3client.exceptions.exceptions import (
     AuthenticationException,
     NotFoundException,
     UnknownException,
 )
-from cs3resource import Resource
-from fixtures import (  # noqa: F401 (they are used, the framework is not detecting it)
+from cs3client.cs3resource import Resource
+from .fixtures import (  # noqa: F401 (they are used, the framework is not detecting it)
     mock_config,
     mock_logger,
     mock_gateway,

examples/shares_api_example.py

@@ -8,7 +8,7 @@
 Last updated: 30/08/2024
 """
 
-from fixtures import (  # noqa: F401, E402 (they are used, the framework is not detecting it)
+from .fixtures import (  # noqa: F401, E402 (they are used, the framework is not detecting it)
     cs3_client_insecure,
     cs3_client_secure,
     mock_config,

examples/user_api_example.py

@@ -11,14 +11,15 @@
 import pytest
 from unittest.mock import Mock, patch
 import cs3.rpc.v1beta1.code_pb2 as cs3code
-from cs3resource import Resource
-from exceptions.exceptions import (
+
+from cs3client.cs3resource import Resource
+from cs3client.exceptions.exceptions import (
     AuthenticationException,
     NotFoundException,
     FileLockedException,
     UnknownException,
 )
-from fixtures import (  # noqa: F401 (they are used, the framework is not detecting it)
+from .fixtures import (  # noqa: F401 (they are used, the framework is not detecting it)
     mock_config,
     mock_logger,
     mock_gateway,

setup.py

@@ -10,7 +10,8 @@
 
 import unittest
 import cs3.storage.provider.v1beta1.resources_pb2 as cs3spr
-from cs3resource import Resource
+
+from cs3client.cs3resource import Resource
 
 
 class TestResource(unittest.TestCase):

tests/__init__.py

@@ -14,14 +14,15 @@
 import cs3.sharing.link.v1beta1.link_api_pb2 as cs3slapi
 import cs3.storage.provider.v1beta1.resources_pb2 as cs3spr
 import cs3.rpc.v1beta1.code_pb2 as cs3code
-from exceptions.exceptions import (
+
+from cs3client.exceptions.exceptions import (
     AuthenticationException,
     NotFoundException,
     UnknownException,
     FileLockedException,
     AlreadyExistsException,
 )
-from fixtures import (  # noqa: F401 (they are used, the framework is not detecting it)
+from .fixtures import (  # noqa: F401 (they are used, the framework is not detecting it)
     mock_config,
     mock_logger,
     mock_gateway,