pilot-platform-common 2.12.2__tar.gz → 2.12.3__tar.gz

{pilot_platform_common-2.12.2 → pilot_platform_common-2.12.3}/PKG-INFO

@@ -1,36 +1,30 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.3
 Name: pilot-platform-common
-Version: 2.12.2
-Summary: Generates entity ID and connects with Vault (secret engine) to retrieve credentials
+Version: 2.12.3
+Summary: Common package used by various Pilot microservices.
 Author: Indoc Systems
 Author-email: support@indocsystems.com
+Requires-Python: >=3.10,<3.13
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.10,<3.13
+Requires-Dist: aioboto3 (>=14.3.0,<15.0.0)
+Requires-Dist: cryptography (>=44.0.2,<45.0.0)
+Requires-Dist: dicttoxml (>=1.7.16,<2.0.0)
+Requires-Dist: httpx (>=0.28.1,<0.29.0)
+Requires-Dist: minio (>=7.2.15,<8.0.0)
+Requires-Dist: opentelemetry-instrumentation-fastapi (>=0.53b1,<0.54)
+Requires-Dist: opentelemetry-sdk (>=1.32.1,<2.0.0)
+Requires-Dist: pydantic (>=2.7.1,<3.0.0)
+Requires-Dist: pyjwt (>=2.10.1,<3.0.0)
+Requires-Dist: python-dotenv (>=0.19.1)
+Requires-Dist: python-json-logger (>=0.1.11,<=2.02)
+Requires-Dist: redis (>=4.5.0,<7.0.0)
+Requires-Dist: starlette (>=0.40.0,<0.47.0)
+Requires-Dist: xmltodict (>=0.14.2,<0.15.0)
 Description-Content-Type: text/markdown
-Requires-Dist: python-dotenv>=0.19.1
-Requires-Dist: httpx==0.28.1
-Requires-Dist: redis<7.0.0,>=4.5.0
-Requires-Dist: aioboto3==14.3.0
-Requires-Dist: xmltodict==0.14.2
-Requires-Dist: minio==7.2.15
-Requires-Dist: python-json-logger==2.0.2
-Requires-Dist: pyjwt==2.10.1
-Requires-Dist: starlette<0.47.0,>=0.40.0
-Requires-Dist: requests<2.32.0,>=2.26.0
-Requires-Dist: cryptography==44.0.2
-Requires-Dist: pydantic<3.0.0,>=2.7.1
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 # common
 
@@ -69,3 +63,4 @@ You can contribute the project in following ways:
 * Suggest a feature.
 * Open a pull request for fixing issues or adding functionality. Please consider using [pre-commit](https://pre-commit.com) in this case.
 * For general guidelines on how to contribute to the project, please take a look at the [contribution guide](CONTRIBUTING.md).
+

pilot_platform_common-2.12.3/common/project/README.md

@@ -0,0 +1,157 @@
+# Project Client
+
+A layer to simplify calling project APIs
+
+## Usage
+
+### Handle Exceptions
+
+Setup error handles in flask/fastapi to allow for automically handling of the exception. Alternatively, you can catch the exceptions manually in your code.
+
+Flask
+```python
+from common import ProjectException
+
+@app.errorhandler(ProjectException)
+def http_exception_handler(exc: ProjectException):
+    return exc.content, exc.status_code
+```
+
+FastAPI
+```python
+from common import ProjectException
+
+@app.exception_handler(ProjectException)
+def http_exception_handler(request: Request, exc: ProjectException):
+    return JSONResponse(
+        status_code=exc.status_code,
+        content=exc.content,
+    )
+```
+
+Manually
+```python
+from common import ProjectException
+
+try:
+    <code>
+except ProjectException as e:
+    <code>
+```
+
+### Initialize client
+
+There are two client, ProjectClient and ProjectClientSync. For async support use ProjectClient. Both clients should be identical other then async support.
+
+REDIS_URL should be in the format `redis://<REDIS_USER>:<REDIS_PASS>@<REDIS_HOST>:<REDIS_PORT>` (`<REDIS_USER>` is the default user in this case)
+
+```python
+from common import ProjectClient
+
+project_client = ProjectClient(ConfigClass.PROJECT_SERVICE, ConfigClass.REDIS_URL)
+```
+
+### Get by code or id
+
+```python
+from common import ProjectClient
+
+
+project_client = ProjectClient(ConfigClass.PROJECT_SERVICE, ConfigClass.REDIS_URL)
+project = await project_client.get(code='indoctestproject')
+project = await project_client.get(id='6fc2201b-272a-4e1e-8fb8-a21ca84208d7')
+
+print(project.name)
+print(project.json()) # converts the project to a dict
+```
+
+### Search for project
+
+```python
+from common import ProjectClient
+
+
+project_client = ProjectClient(ConfigClass.PROJECT_SERVICE, ConfigClass.REDIS_URL)
+results = await project_client.search(
+    page=1,
+    page_size=10,
+    description='test'
+)
+
+# Sorting
+results = await project_client.search(
+    page=1,
+    page_size=10,
+    order_by='created_at', # name, code also supported
+    order_type='asc', # or desc
+)
+
+# Create time range
+results = await project_client.search(
+    page=1,
+    page_size=10,
+    created_at_start=1653494559, # or datetime in ISO format
+    created_at_start=1653494559,
+)
+
+# Tags format
+results = await project_client.search(
+    page=1,
+    page_size=10,
+    tags_all='test1,test2'
+)
+
+# Batch search by code
+results = await project_client.search(
+    page=1,
+    page_size=10,
+    code_any='code1,code2'
+)
+
+print(results["page"])
+print(results["page_size"])
+for project in results["results"]:
+    print(project.name)
+```
+
+
+### Create project
+
+```python
+from common import ProjectClient
+
+
+project_client = ProjectClient(ConfigClass.PROJECT_SERVICE, ConfigClass.REDIS_URL)
+project = await project_client.create(
+    code="gregtestnewproject3",
+    name="Greg Test New Project",
+    description="Greg is testing new projects",
+    tags=["greg", "test"],
+    system_tags=["copied-to-core"],
+    image_url="http://example.com/image.jpeg",
+    is_discoverable=True,
+)
+```
+
+### Update project
+
+```python
+from common import ProjectClient
+
+
+project_client = ProjectClient(ConfigClass.PROJECT_SERVICE, ConfigClass.REDIS_URL)
+project = await project.get('indoctestproject')
+await project.update(description="Changed3")
+print(project.name)
+```
+
+### Upload logo
+
+```python
+from common import ProjectClient
+
+
+project_client = ProjectClient(ConfigClass.PROJECT_SERVICE, ConfigClass.REDIS_URL)
+project = await project.get('indoctestproject')
+project.upload_logo("<base64 encoded image data>")
+```

{pilot_platform_common-2.12.2 → pilot_platform_common-2.12.3}/pyproject.toml

@@ -1,8 +1,19 @@
 [tool.poetry]
-name = "common"
-version = "2.12.2"
+name = "pilot-platform-common"
+version = "2.12.3"
 description = "Common package used by various Pilot microservices."
-authors = ["Indoc Systems"]
+authors = ["Indoc Systems <support@indocsystems.com>"]
+readme = "README.md"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent"
+]
+packages = [
+    { include = "common" }
+]
 
 [tool.poetry.dependencies]
 python = ">=3.10,<3.13"
@@ -16,7 +27,7 @@ pyjwt = "^2.10.1"
 redis = ">=4.5.0,<7.0.0"
 starlette = ">=0.40.0,<0.47.0"
 cryptography = "^44.0.2"
-pydantic = "^2.10.6"
+pydantic = ">=2.7.1,<3.0.0"
 opentelemetry-instrumentation-fastapi = "^0.53b1"
 opentelemetry-sdk = "^1.32.1"
 dicttoxml = "^1.7.16"
@@ -39,9 +50,11 @@ asyncio_mode = "auto"
 plugins = ["pydantic.mypy"]
 ignore_missing_imports = true
 
-[tool.coverage.run]
-omit = ["./setup.py"]
-
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
+
+include = [
+    { path = "common/**/*.crt", format = "file" },
+    { path = "README.md", format = "text/markdown" }
+]

pilot_platform_common-2.12.2/pilot_platform_common.egg-info/PKG-INFO

@@ -1,71 +0,0 @@
-Metadata-Version: 2.4
-Name: pilot-platform-common
-Version: 2.12.2
-Summary: Generates entity ID and connects with Vault (secret engine) to retrieve credentials
-Author: Indoc Systems
-Author-email: support@indocsystems.com
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.10,<3.13
-Description-Content-Type: text/markdown
-Requires-Dist: python-dotenv>=0.19.1
-Requires-Dist: httpx==0.28.1
-Requires-Dist: redis<7.0.0,>=4.5.0
-Requires-Dist: aioboto3==14.3.0
-Requires-Dist: xmltodict==0.14.2
-Requires-Dist: minio==7.2.15
-Requires-Dist: python-json-logger==2.0.2
-Requires-Dist: pyjwt==2.10.1
-Requires-Dist: starlette<0.47.0,>=0.40.0
-Requires-Dist: requests<2.32.0,>=2.26.0
-Requires-Dist: cryptography==44.0.2
-Requires-Dist: pydantic<3.0.0,>=2.7.1
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# common
-
-[![Run Tests](https://github.com/PilotDataPlatform/common/actions/workflows/run-tests.yml/badge.svg?branch=develop)](https://github.com/PilotDataPlatform/common/actions/workflows/run-tests.yml)
-[![Python](https://img.shields.io/badge/python-3.12-brightgreen.svg)](https://www.python.org/)
-[![PyPI](https://img.shields.io/pypi/v/pilot-platform-common.svg)](https://pypi.org/project/pilot-platform-common/)
-
-Importable package responsible for cross-service tasks within the Pilot Platform (e.g. logging, Vault connection, etc.).
-
-
-## Getting Started
-
-### Installation & Quick Start
-The latest version of the common package is available on [PyPi](https://pypi.org/project/pilot-platform-common/) and can be installed into another service via Pip.
-
-Pip install from PyPi:
-```
-pip install pilot-platform-common
-```
-
-In `pyproject.toml`:
-```
-pilot-platform-common = "^<VERSION>"
-```
-
-Pip install from a local `.whl` file:
-```
-pip install pilot_platform_common-<VERSION>-py3-none-any.whl
-```
-
-## Contribution
-
-You can contribute the project in following ways:
-
-* Report a bug.
-* Suggest a feature.
-* Open a pull request for fixing issues or adding functionality. Please consider using [pre-commit](https://pre-commit.com) in this case.
-* For general guidelines on how to contribute to the project, please take a look at the [contribution guide](CONTRIBUTING.md).

pilot_platform_common-2.12.2/pilot_platform_common.egg-info/SOURCES.txt

@@ -1,55 +0,0 @@
-README.md
-pyproject.toml
-setup.py
-common/__init__.py
-common/geid/__init__.py
-common/geid/geid_client.py
-common/jwt_handler/JWTHandler.py
-common/jwt_handler/__init__.py
-common/jwt_handler/jwt_handler_exception.py
-common/jwt_handler/models.py
-common/logging/__init__.py
-common/logging/formatter.py
-common/logging/logger.py
-common/logging/logging.py
-common/models/__init__.py
-common/models/config_center_policy.py
-common/models/service_id_generator.py
-common/object_storage_adaptor/__init__.py
-common/object_storage_adaptor/base_client.py
-common/object_storage_adaptor/boto3_admin_client.py
-common/object_storage_adaptor/boto3_client.py
-common/object_storage_adaptor/minio_policy_client.py
-common/permissions/__init__.py
-common/permissions/exceptions.py
-common/permissions/permissions.py
-common/permissions/permissions_manager.py
-common/permissions/schemas.py
-common/project/__init__.py
-common/project/project_client.py
-common/project/project_exceptions.py
-common/services/__init__.py
-common/services/auth_client.py
-common/vault/__init__.py
-common/vault/vault_client.py
-common/vault/vault_exception.py
-pilot_platform_common.egg-info/PKG-INFO
-pilot_platform_common.egg-info/SOURCES.txt
-pilot_platform_common.egg-info/dependency_links.txt
-pilot_platform_common.egg-info/requires.txt
-pilot_platform_common.egg-info/top_level.txt
-tests/__init__.py
-tests/conftest.py
-tests/test_formatter.py
-tests/test_geid_client.py
-tests/test_jwt_handler.py
-tests/test_logging.py
-tests/test_project_client.py
-tests/test_vault_client.py
-tests/fixtures/__init__.py
-tests/fixtures/fake.py
-tests/fixtures/metadata.py
-tests/permissions/__init__.py
-tests/permissions/test_auth_client.py
-tests/permissions/test_permissions.py
-tests/permissions/test_permissions_manager.py

pilot_platform_common-2.12.2/pilot_platform_common.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

pilot_platform_common-2.12.2/pilot_platform_common.egg-info/requires.txt

@@ -1,12 +0,0 @@
-python-dotenv>=0.19.1
-httpx==0.28.1
-redis<7.0.0,>=4.5.0
-aioboto3==14.3.0
-xmltodict==0.14.2
-minio==7.2.15
-python-json-logger==2.0.2
-pyjwt==2.10.1
-starlette<0.47.0,>=0.40.0
-requests<2.32.0,>=2.26.0
-cryptography==44.0.2
-pydantic<3.0.0,>=2.7.1

pilot_platform_common-2.12.2/pilot_platform_common.egg-info/top_level.txt

@@ -1,2 +0,0 @@
-common
-tests

pilot_platform_common-2.12.2/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

pilot_platform_common-2.12.2/setup.py

@@ -1,47 +0,0 @@
-# Copyright (C) 2022-2025 Indoc Systems
-#
-# Contact Indoc Systems for any questions regarding the use of this source code.
-
-from pathlib import Path
-
-import setuptools
-
-this_directory = Path(__file__).parent
-long_description = (this_directory / 'README.md').read_text()
-
-setuptools.setup(
-    name='pilot-platform-common',
-    version='2.12.2',
-    author='Indoc Systems',
-    author_email='support@indocsystems.com',
-    description='Generates entity ID and connects with Vault (secret engine) to retrieve credentials',
-    long_description=long_description,
-    long_description_content_type='text/markdown',
-    packages=setuptools.find_packages(),
-    classifiers=[
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.10',
-        'Programming Language :: Python :: 3.11',
-        'Programming Language :: Python :: 3.12',
-        'Operating System :: OS Independent',
-    ],
-    python_requires='>=3.10,<3.13',
-    install_requires=[
-        'python-dotenv>=0.19.1',
-        'httpx==0.28.1',
-        'redis>=4.5.0,<7.0.0',
-        'aioboto3==14.3.0',
-        'xmltodict==0.14.2',
-        'minio==7.2.15',
-        'python-json-logger==2.0.2',
-        'pyjwt==2.10.1',
-        'starlette>=0.40.0,<0.47.0',
-        'requests>=2.26.0,<2.32.0',
-        'cryptography==44.0.2',
-        'pydantic>=2.7.1,<3.0.0',
-    ],
-    include_package_data=True,
-    package_data={
-        '': ['*.crt'],
-    },
-)

pilot_platform_common-2.12.2/tests/__init__.py

@@ -1,3 +0,0 @@
-# Copyright (C) 2022-2025 Indoc Systems
-#
-# Contact Indoc Systems for any questions regarding the use of this source code.