sgnl-api 0.0.1__tar.gz

sgnl_api-0.0.1/LICENSE

@@ -0,0 +1,10 @@
+MIT License
+
+Copyright (c) [2024] [Igor Gritsyuk]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

sgnl_api-0.0.1/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.1
+Name: sgnl-api
+Version: 0.0.1
+Summary: Asynchronous python wrapper over API sgnl.pro
+Home-page: https://github.com/gritsyuk/sgnl-api
+Download-URL: https://github.com/gritsyuk/sgnl-api/archive/refs/heads/develop.zip
+Author: Igor Gritsyuk
+Author-email: gritsyuk.igor@gmail.com
+Project-URL: GitHub, https://github.com/gritsyuk/sgnl-api
+Keywords: sgnl api signal docs construction supervision operation inspections constarctionsite building management
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27.2
+Requires-Dist: aiofiles>=24.1.0
+
+# <img src="./img/logo.svg"> SIGNAL API
+
+![PyPI - Version](https://img.shields.io/pypi/v/sgnl-api) [![Telegram chat](https://img.shields.io/badge/Просто_о_BIM-join-blue?logo=telegram)](https://t.me/prostobim)
+## Обертка над API Signal 
+Официальная документация [https://api.sgnl.pro/openapi/swagger/index.html](https://api.sgnl.pro/openapi/swagger/index.html)
+## Установка
+```bash
+pip install -U sgnl-api
+```
+
+## Пример
+```python
+import asyncio
+import os
+from sgnl_api import DocsApi
+from dotenv import load_dotenv
+
+load_dotenv()
+CLIENT_ID = os.getenv("CLIENT_ID")
+SECRET_ID = os.getenv("SECRET_ID")
+
+
+async def main():
+
+    docs = await DocsApi.create(
+        client_id=CLIENT_ID,
+        client_secret=SECRET_ID
+    )
+    projects = await docs.project.get_list()
+    for project in projects:
+        print(project)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+## Методы
+| Методы                      | Описание                                |
+|-----------------------------|-----------------------------------------|
+| `Item.get_list`             | Список файлов в директории              |
+| `Item.count`                | Количество файлов в директории          |
+| `Item.download_link`        | Получить ссылку на скачивание           |
+| `Item.create`               | Создать файл                            |
+| `Item.create_link`          | Создать ссылку                          |
+| `Item.new_version`          | Создать новую версию                    |
+| `Folder.get_list`           | Список подкаталогов в каталоге          |
+| `Folder.create`             | Создать каталог                         |          
+| `Folder.update`             | Переименовать каталог                   |
+| `Project.root_folder`       | Данные корневой папки проекта           |
+| `Project.root_folder_id`    | UUID корневой папки                     |
+| `Project.get_list`          | Список проектов                         |
+| `Project.info`              | Информация о проекте                    |
+| `Project.users`             | Список пользователей проекта            |
+| `Project.roles`             | Список ролей проекта                    |
+| `Project.users_permissions` | Права доступа у пользователя на проекте |
+| `Company.users_list`        | Список пользователей компании           |
+| `Company.roles_list`        | Список ролей компании                   |
+| `Version.list`              | Список версий файла                     |
+| `Version.count`             | Количество версий у файла               |
+| `Version.new`               | Новая версия                            |
+| `File.get_object_upload`    | Получение ссылки загрузки и id объекта  |
+| `File.commit_uploading`     | Записать сведения в S3                  |
+| `File.upload`               | Загрузка объекта полный цикл            |

sgnl_api-0.0.1/README.md

@@ -0,0 +1,63 @@
+# <img src="./img/logo.svg"> SIGNAL API
+
+![PyPI - Version](https://img.shields.io/pypi/v/sgnl-api) [![Telegram chat](https://img.shields.io/badge/Просто_о_BIM-join-blue?logo=telegram)](https://t.me/prostobim)
+## Обертка над API Signal 
+Официальная документация [https://api.sgnl.pro/openapi/swagger/index.html](https://api.sgnl.pro/openapi/swagger/index.html)
+## Установка
+```bash
+pip install -U sgnl-api
+```
+
+## Пример
+```python
+import asyncio
+import os
+from sgnl_api import DocsApi
+from dotenv import load_dotenv
+
+load_dotenv()
+CLIENT_ID = os.getenv("CLIENT_ID")
+SECRET_ID = os.getenv("SECRET_ID")
+
+
+async def main():
+
+    docs = await DocsApi.create(
+        client_id=CLIENT_ID,
+        client_secret=SECRET_ID
+    )
+    projects = await docs.project.get_list()
+    for project in projects:
+        print(project)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+## Методы
+| Методы                      | Описание                                |
+|-----------------------------|-----------------------------------------|
+| `Item.get_list`             | Список файлов в директории              |
+| `Item.count`                | Количество файлов в директории          |
+| `Item.download_link`        | Получить ссылку на скачивание           |
+| `Item.create`               | Создать файл                            |
+| `Item.create_link`          | Создать ссылку                          |
+| `Item.new_version`          | Создать новую версию                    |
+| `Folder.get_list`           | Список подкаталогов в каталоге          |
+| `Folder.create`             | Создать каталог                         |          
+| `Folder.update`             | Переименовать каталог                   |
+| `Project.root_folder`       | Данные корневой папки проекта           |
+| `Project.root_folder_id`    | UUID корневой папки                     |
+| `Project.get_list`          | Список проектов                         |
+| `Project.info`              | Информация о проекте                    |
+| `Project.users`             | Список пользователей проекта            |
+| `Project.roles`             | Список ролей проекта                    |
+| `Project.users_permissions` | Права доступа у пользователя на проекте |
+| `Company.users_list`        | Список пользователей компании           |
+| `Company.roles_list`        | Список ролей компании                   |
+| `Version.list`              | Список версий файла                     |
+| `Version.count`             | Количество версий у файла               |
+| `Version.new`               | Новая версия                            |
+| `File.get_object_upload`    | Получение ссылки загрузки и id объекта  |
+| `File.commit_uploading`     | Записать сведения в S3                  |
+| `File.upload`               | Загрузка объекта полный цикл            |

sgnl_api-0.0.1/setup.cfg

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

sgnl_api-0.0.1/setup.py

@@ -0,0 +1,28 @@
+from setuptools import setup, find_packages
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setup(
+    name='sgnl-api',
+    version='0.0.1',
+    author='Igor Gritsyuk',
+    author_email='gritsyuk.igor@gmail.com',
+    description='Asynchronous python wrapper over API sgnl.pro',
+    download_url='https://github.com/gritsyuk/sgnl-api/archive/refs/heads/develop.zip',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    url='https://github.com/gritsyuk/sgnl-api',
+    packages=find_packages(include=['sgnl_api', 'sgnl_api.*']),
+    install_requires=['httpx>=0.27.2', 'aiofiles>=24.1.0'],
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent'
+    ],
+    keywords='sgnl api signal docs construction supervision operation inspections constarctionsite building management',
+    project_urls={
+        'GitHub': 'https://github.com/gritsyuk/sgnl-api'
+    },
+    python_requires='>=3.9'
+)

sgnl_api-0.0.1/sgnl_api/__init__.py

@@ -0,0 +1 @@
+from .docs_api import DocsApi

sgnl_api-0.0.1/sgnl_api/decorators.py

@@ -0,0 +1,9 @@
+def extract_key_from_response(key: str):
+    def decorator(func):
+        async def wrapper(*args, **kwargs):
+            response = await func(*args, **kwargs)
+            if isinstance(response, dict) and key in response:
+                return response[key]
+            return response
+        return wrapper
+    return decorator

sgnl_api-0.0.1/sgnl_api/docs_api.py

@@ -0,0 +1,501 @@
+import httpx
+from uuid import UUID
+from datetime import datetime, timedelta
+from .scopes import SCOPES_DEFAULT
+from .decorators import extract_key_from_response
+from .file import read_file
+from .utils import keys_to_snake_case
+
+
+class DocsApi:
+    """DocsApi client for interacting with the SGNL DOCS API.
+    Do not initialize this class directly. Use the create() classmethod instead:
+    Example:
+        ```python
+        api = await DocsApi.create(client_id="your_id", client_secret="your_secret")
+        ```
+    """
+
+    def __init__(self,
+                 *,
+                 client_id: str,
+                 client_secret: str,
+                 scopes: list[str] = SCOPES_DEFAULT) -> None:
+        self.client_id = client_id
+        self.client_secret = client_secret
+        self.scopes = [*scopes]
+        self.base_url = "https://api.sgnl.pro/public/v1"
+        self._jwt = None
+        self._jwt_expires_at = None
+
+        self.item = self.Item(self)
+        self.folder = self.Folder(self)
+        self.project = self.Project(self)
+        self.company = self.Company(self)
+        self.version = self.Version(self)
+        self.file = self.File(self)
+
+    @classmethod
+    async def create(
+            cls,
+            *,
+            client_id: str,
+            client_secret: str,
+            scopes: list[str] = SCOPES_DEFAULT) -> "DocsApi":
+        """Create and initialize a new DocsApi instance.
+               Args:
+                   client_id: Your SGNL DOCS API client ID
+                   client_secret: Your SGNL DOCS API client secret
+                   scopes: List of scopes
+               Returns:
+                   An initialized DocsApi instance
+               Example:
+                   ```python
+                   api = await DocsApi.create(
+                       client_id="your_id",
+                       client_secret="your_secret"
+                   )
+                   ```
+               """
+        instance = cls(client_id=client_id, client_secret=client_secret, scopes=scopes)
+        await instance._ensure_token()
+        return instance
+
+    async def _ensure_token(self):
+        if self._jwt is None or (self._jwt_expires_at and datetime.now() >= self._jwt_expires_at):
+            try:
+                async with httpx.AsyncClient() as client:
+                    response = await client.post(
+                        f'{self.base_url}/auth/token',
+                        json={
+                            "clientId": self.client_id,
+                            "clientSecret": self.client_secret,
+                            "scopes": self.scopes
+                        },
+                        headers={'Content-Type': 'application/json'}
+                    )
+                    response.raise_for_status()
+                    data = response.json()
+                    self._jwt = data.get('token')
+                    expires_in = data.get('expiresIn', 3600)
+                    self._jwt_expires_at = datetime.now() + timedelta(seconds=expires_in)
+            except Exception as e:
+                raise Exception(f"AUTHENTICATION ERROR: {e}")
+
+    async def _make_request(
+            self,
+            method: str,
+            url: str,
+            params: dict = None,
+            json: dict = None,
+            headers: dict = None) -> str:
+
+        error_messages = {
+            400: "Bad request",
+            401: "The request did not have the correct authorization header credentials.",
+            403: "Forbidden",
+            404: "Not Found",
+            450: "Maximum resource quota reached. To increase the quota, contact support.",
+            500: "Api server error"
+        }
+
+        try:
+            await self._ensure_token()
+            async with httpx.AsyncClient() as client:
+                response = await client.request(
+                    method=method,
+                    url=url,
+                    params=params,
+                    json=json,
+                    headers=headers)
+
+                if response.is_success:
+                    return keys_to_snake_case(response.json())
+                else:
+                    error_message = error_messages.get(response.status_code, "Неизвестная ошибка")
+                    return {
+                        "error": response.status_code,
+                        "message": error_message
+                    }
+        except Exception as e:
+            raise Exception(f"Error: {e}")
+
+    def _get_headers(self, additional_headers: dict = None) -> dict:
+        headers = {
+            "accept": "application/json",
+            "Authorization": f"Bearer {self._jwt}"
+        }
+        if additional_headers:
+            headers.update(additional_headers)
+        return headers
+
+    class Item:
+        def __init__(self, api: 'DocsApi'):
+            self.api = api
+
+        async def get_list(
+                self,
+                folder_id: UUID,
+                deleted: bool = False,
+                take: int = 100,
+                skip: int = 0
+        ) -> list[dict]:
+            return await self.api._make_request(
+                method='GET',
+                url=f'{self.api.base_url}/items',
+                params={
+                    'folderId': folder_id,
+                    'take': take,
+                    'skip': skip,
+                    'deleted': deleted
+                },
+                headers=self.api._get_headers()
+            )
+
+        @extract_key_from_response(key="data")
+        async def count(
+                self,
+                folder_id: UUID,
+                deleted: bool = False
+        ) -> int:
+            return await self.api._make_request(
+                method='GET',
+                url=f'{self.api.base_url}/items/count',
+                params={
+                    'folderId': folder_id,
+                    'deleted': deleted
+                },
+                headers=self.api._get_headers()
+            )
+
+        async def download_link(
+                self,
+                folder_id: UUID,
+                version_id: UUID,
+                file_name: str = None
+        ):
+            params = {
+                'folderId': folder_id,
+                'versionId': version_id
+            }
+            if file_name:
+                params['fileName'] = file_name
+            return await self.api._make_request(
+                method='GET',
+                url=f'{self.api.base_url}/items/download',
+                params=params,
+                headers=self.api._get_headers()
+            )
+
+        async def create(
+                self,
+                name: str,
+                folder_id: UUID,
+                version_id: UUID
+        ) -> dict:
+            return await self.api._make_request(
+                method='PUT',
+                url=f'{self.api.base_url}/items/file',
+                json={
+                    'name': name,
+                    'folderId': folder_id,
+                    'versionId': version_id
+                },
+                headers=self.api._get_headers()
+            )
+
+        async def create_link(
+                self,
+                name: str,
+                folder_id: UUID,
+                version_id: UUID
+        ) -> dict:
+            return await self.api._make_request(
+                method='PUT',
+                url=f'{self.api.base_url}/items/link',
+                json={
+                    'name': name,
+                    'folderId': folder_id,
+                    'versionId': version_id
+                },
+                headers=self.api._get_headers()
+            )
+
+        async def new_version(
+                self,
+                item_id: UUID,
+                version_id: UUID
+        ) -> dict:
+            return await self.api._make_request(
+                method='PUT',
+                url=f'{self.api.base_url}/items/versions',
+                json={
+                    'folderId': item_id,
+                    'versionId': version_id
+                },
+                headers=self.api._get_headers()
+            )
+
+    class Folder:
+        def __init__(self, api: 'DocsApi'):
+            self.api = api
+
+        async def get_list(
+                self,
+                folder_id: UUID,
+                deleted: bool = False
+        ) -> list[dict]:
+            return await self.api._make_request(
+                method='GET',
+                url=f'{self.api.base_url}/folders/{folder_id}/children',
+                params={
+                    'deleted': deleted
+                },
+                headers=self.api._get_headers()
+            )
+
+        async def create(
+                self,
+                parent_id: UUID,
+                name: str = 'new folder from api'
+        ) -> dict:
+            return await self.api._make_request(
+                method='PUT',
+                url=f'{self.api.base_url}/folders',
+                json={
+                    'parentId': parent_id,
+                    'name': name
+                },
+                headers=self.api._get_headers()
+            )
+
+        async def update(
+                self,
+                folder_id: UUID,
+                name: str
+        ) -> dict:
+            return await self.api._make_request(
+                method='PATCH',
+                url=f'{self.api.base_url}/folders',
+                json={
+                    'id': folder_id,
+                    'name': name
+                },
+                headers=self.api._get_headers()
+            )
+
+    class Project:
+        def __init__(self, api: 'DocsApi'):
+            self.api = api
+
+        async def root_folder(
+                self,
+                project_id: UUID) -> dict:
+            return await self.api._make_request(
+                method='GET',
+                url=f'{self.api.base_url}/docs/projects/{project_id}',
+                headers=self.api._get_headers()
+            )
+
+        @extract_key_from_response(key='root_folder_id')
+        async def root_folder_id(self, project_id: UUID) -> dict:
+            return await self.root_folder(project_id)
+
+        async def get_list(
+                self,
+                take: int = 100,
+                skip: int = 0
+        ) -> list[dict]:
+            return await self.api._make_request(
+                method='GET',
+                url=f'{self.api.base_url}/projects',
+                params={
+                    'Take': take,
+                    'Skip': skip
+                },
+                headers=self.api._get_headers()
+            )
+
+        async def info(
+                self,
+                project_id: UUID
+        ) -> dict:
+            return await self.api._make_request(
+                method='GET',
+                url=f'{self.api.base_url}/projects/{project_id}',
+                headers=self.api._get_headers()
+            )
+
+        async def users(
+                self,
+                project_id: UUID,
+                take: int = 100,
+                skip: int = 0
+        ) -> list[dict]:
+            return await self.api._make_request(
+                method='GET',
+                url=f'{self.api.base_url}/projects/{project_id}/users',
+                params={
+                    'Take': take,
+                    'Skip': skip
+                },
+                headers=self.api._get_headers()
+            )
+
+        async def roles(
+                self,
+                project_id: UUID,
+                take: int = 100,
+                skip: int = 0
+        ) -> list[dict]:
+            return await self.api._make_request(
+                method='GET',
+                url=f'{self.api.base_url}/projects/{project_id}/roles',
+                params={
+                    'Take': take,
+                    'Skip': skip
+                },
+                headers=self.api._get_headers()
+            )
+
+        async def users_permissions(
+                self,
+                project_id: UUID,
+                user_id: UUID
+        ) -> dict:
+            return await self.api._make_request(
+                method='GET',
+                url=f'{self.api.base_url}/projects/{project_id}/users/{user_id}/permission',
+                headers=self.api._get_headers()
+            )
+
+    class Company:
+        def __init__(self, api: 'DocsApi'):
+            self.api = api
+
+        async def users_list(self, take: int = 100, skip: int = 0) -> list[dict]:
+            return await self.api._make_request(
+                method='GET',
+                url=f'{self.api.base_url}/company/users',
+                params={
+                    'Take': take,
+                    'Skip': skip
+                },
+                headers=self.api._get_headers()
+            )
+
+        async def roles_list(self, take: int = 100, skip: int = 0) -> list[dict]:
+            return await self.api._make_request(
+                method='GET',
+                url=f'{self.api.base_url}/company/roles',
+                params={
+                    'Take': take,
+                    'Skip': skip
+                },
+                headers=self.api._get_headers()
+            )
+
+    class Version:
+        def __init__(self, api: 'DocsApi'):
+            self.api = api
+
+        async def list(
+                self,
+                item_id: UUID,
+                take: int = 100,
+                skip: int = 0
+        ) -> list[dict]:
+            return await self.api._make_request(
+                method='GET',
+                url=f'{self.api.base_url}/versions',
+                params={
+                    'itemId': item_id,
+                    'Take': take,
+                    'Skip': skip
+                },
+                headers=self.api._get_headers()
+            )
+
+        @extract_key_from_response(key="data")
+        async def count(
+                self,
+                item_id: UUID
+        ) -> dict:
+            return await self.api._make_request(
+                method='GET',
+                url=f'{self.api.base_url}/versions',
+                params={
+                    'itemId': item_id
+                },
+                headers=self.api._get_headers()
+            )
+
+        async def new(
+                self,
+                *,
+                object_id: UUID,
+                project_id: UUID,
+                name: str
+        ) -> dict:
+            return await self.api._make_request(
+                method='POST',
+                url=f'{self.api.base_url}/versions',
+                json={
+                    'objectId': object_id,
+                    'projectId': project_id,
+                    'name': name
+                },
+                headers=self.api._get_headers()
+            )
+
+    class File:
+        def __init__(self, api: 'DocsApi'):
+            self.api = api
+
+        async def get_object_upload(
+                self,
+                project_id: UUID,
+                mime_type: str,
+                size: int
+        ) -> dict:
+            return await self.api._make_request(
+                method='PUT',
+                url=f'{self.api.base_url}/objects',
+                json={
+                    "projectId": project_id,
+                    "mimeType": mime_type,
+                    "size": size
+                },
+                headers=self.api._get_headers()
+            )
+
+        async def commit_uploading(
+                self,
+                object_id: UUID
+        ) -> dict:
+            return await self.api._make_request(
+                method='POST',
+                url=f'{self.api.base_url}/objects/{object_id}/uploading/commit',
+                headers=self.api._get_headers()
+            )
+
+        async def upload(self, project_id: UUID, file_path: str):
+            file_info = await read_file(file_path)
+            if file_info is None:
+                raise FileExistsError
+            file_data, mime_type, size = file_info
+            object_upload = await self.get_object_upload(project_id, mime_type, size)
+            async with httpx.AsyncClient() as client:
+                upload_response = await client.put(
+                    object_upload.get("signed_url"),
+                    content=file_data
+                )
+                if upload_response.status_code != 200:
+                    return {
+                        "error": upload_response.status_code,
+                        "message": upload_response.text
+                    }
+
+            result_status = await self.commit_uploading(project_id, object_upload.get("object_id"))
+
+            return result_status

sgnl_api-0.0.1/sgnl_api/file.py

@@ -0,0 +1,18 @@
+import aiofiles
+import mimetypes
+import os
+
+
+async def read_file(file_path):
+    async with aiofiles.open(file_path, 'rb') as file:
+        file_data = await file.read()
+
+    mime_type, _ = mimetypes.guess_type(file_path)
+    size = os.path.getsize(file_path)
+
+    if size == 0 or mime_type is None:
+        return None
+
+    return file_data, mime_type, size
+
+

sgnl_api-0.0.1/sgnl_api/scopes.py

@@ -0,0 +1,19 @@
+SCOPES_DEFAULT = (
+    "project:read",
+    "project:list",
+    "project:user:list",
+    "project:user:read",
+    "project:role:list",
+    "docs:object:create",
+    "docs:signing:list",
+    "docs:signing:create",
+    "docs:folder:list",
+    "docs:folder:create",
+    "docs:folder:update",
+    "docs:item:create",
+    "docs:item:list",
+    "docs:item:read",
+    "docs:version:create",
+    "docs:version:create",
+    "docs:version:list"
+)

sgnl_api-0.0.1/sgnl_api/utils.py

@@ -0,0 +1,45 @@
+import re
+from typing import Dict, List, Any, TypeVar, Optional
+from functools import lru_cache
+
+T = TypeVar('T', Dict, List, Any)
+
+
+@lru_cache(maxsize=128)
+def camel_to_snake(string: str) -> str:
+    """
+    Конвертирует строку из camelCase в snake_case.
+    Args:
+        string: Строка в формате camelCase
+    Returns:
+        Строка в формате snake_case
+    Examples:
+        >>> camel_to_snake("camelCase")
+        'camel_case'
+        >>> camel_to_snake("HTTPResponse")
+        'http_response'
+    """
+    string = re.sub(r'([A-Z]+)([A-Z][a-z])', r'\1_\2', string)
+    string = re.sub(r'([a-z0-9])([A-Z])', r'\1_\2', string)
+    return string.lower()
+
+
+def keys_to_snake_case(data: T, max_depth: Optional[int] = None, _current_depth: int = 0) -> T:
+    if max_depth is not None and _current_depth > max_depth:
+        raise ValueError(f"Maximum depth exceeded: {max_depth}")
+
+    if isinstance(data, dict):
+        return {
+            camel_to_snake(str(key)): keys_to_snake_case(value, max_depth, _current_depth + 1)
+            if isinstance(value, (dict, list))
+            else value
+            for key, value in data.items()
+        }
+    elif isinstance(data, list):
+        return [
+            keys_to_snake_case(item, max_depth, _current_depth + 1)
+            if isinstance(item, (dict, list))
+            else item
+            for item in data
+        ]
+    return data

sgnl_api-0.0.1/sgnl_api.egg-info/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.1
+Name: sgnl-api
+Version: 0.0.1
+Summary: Asynchronous python wrapper over API sgnl.pro
+Home-page: https://github.com/gritsyuk/sgnl-api
+Download-URL: https://github.com/gritsyuk/sgnl-api/archive/refs/heads/develop.zip
+Author: Igor Gritsyuk
+Author-email: gritsyuk.igor@gmail.com
+Project-URL: GitHub, https://github.com/gritsyuk/sgnl-api
+Keywords: sgnl api signal docs construction supervision operation inspections constarctionsite building management
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27.2
+Requires-Dist: aiofiles>=24.1.0
+
+# <img src="./img/logo.svg"> SIGNAL API
+
+![PyPI - Version](https://img.shields.io/pypi/v/sgnl-api) [![Telegram chat](https://img.shields.io/badge/Просто_о_BIM-join-blue?logo=telegram)](https://t.me/prostobim)
+## Обертка над API Signal 
+Официальная документация [https://api.sgnl.pro/openapi/swagger/index.html](https://api.sgnl.pro/openapi/swagger/index.html)
+## Установка
+```bash
+pip install -U sgnl-api
+```
+
+## Пример
+```python
+import asyncio
+import os
+from sgnl_api import DocsApi
+from dotenv import load_dotenv
+
+load_dotenv()
+CLIENT_ID = os.getenv("CLIENT_ID")
+SECRET_ID = os.getenv("SECRET_ID")
+
+
+async def main():
+
+    docs = await DocsApi.create(
+        client_id=CLIENT_ID,
+        client_secret=SECRET_ID
+    )
+    projects = await docs.project.get_list()
+    for project in projects:
+        print(project)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+## Методы
+| Методы                      | Описание                                |
+|-----------------------------|-----------------------------------------|
+| `Item.get_list`             | Список файлов в директории              |
+| `Item.count`                | Количество файлов в директории          |
+| `Item.download_link`        | Получить ссылку на скачивание           |
+| `Item.create`               | Создать файл                            |
+| `Item.create_link`          | Создать ссылку                          |
+| `Item.new_version`          | Создать новую версию                    |
+| `Folder.get_list`           | Список подкаталогов в каталоге          |
+| `Folder.create`             | Создать каталог                         |          
+| `Folder.update`             | Переименовать каталог                   |
+| `Project.root_folder`       | Данные корневой папки проекта           |
+| `Project.root_folder_id`    | UUID корневой папки                     |
+| `Project.get_list`          | Список проектов                         |
+| `Project.info`              | Информация о проекте                    |
+| `Project.users`             | Список пользователей проекта            |
+| `Project.roles`             | Список ролей проекта                    |
+| `Project.users_permissions` | Права доступа у пользователя на проекте |
+| `Company.users_list`        | Список пользователей компании           |
+| `Company.roles_list`        | Список ролей компании                   |
+| `Version.list`              | Список версий файла                     |
+| `Version.count`             | Количество версий у файла               |
+| `Version.new`               | Новая версия                            |
+| `File.get_object_upload`    | Получение ссылки загрузки и id объекта  |
+| `File.commit_uploading`     | Записать сведения в S3                  |
+| `File.upload`               | Загрузка объекта полный цикл            |

sgnl_api-0.0.1/sgnl_api.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+setup.py
+sgnl_api/__init__.py
+sgnl_api/decorators.py
+sgnl_api/docs_api.py
+sgnl_api/file.py
+sgnl_api/scopes.py
+sgnl_api/utils.py
+sgnl_api.egg-info/PKG-INFO
+sgnl_api.egg-info/SOURCES.txt
+sgnl_api.egg-info/dependency_links.txt
+sgnl_api.egg-info/requires.txt
+sgnl_api.egg-info/top_level.txt

sgnl_api-0.0.1/sgnl_api.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sgnl_api-0.0.1/sgnl_api.egg-info/requires.txt

@@ -0,0 +1,2 @@
+httpx>=0.27.2
+aiofiles>=24.1.0

sgnl_api-0.0.1/sgnl_api.egg-info/top_level.txt

@@ -0,0 +1 @@
+sgnl_api