sgnl-api 0.0.2__tar.gz → 0.0.3__tar.gz

sgnl_api-0.0.3/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.1
+Name: sgnl-api
+Version: 0.0.3
+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`         | Список файлов в директории                                       | `list[dict]`       |
+| `item.count`            | Количество файлов в директории                                   | `int`              |
+| `item.create_file`      | Создает новый файл с версией                                     | `UUID`             |
+| `item.create_link`      | Создает новую ссылку                                             | `UUID`             |
+| `item.get_link`         | Получает ссылку для загрузки файла                               | `dict`             |
+| `item.add_version`      | Добавляет новую версию к существующему файлу                     | `None`             |
+| `folder.get_list`       | Список дочерних папок                                            | `list[dict]`       |
+| `folder.create`         | Создает новую папку                                              | `UUID`             |
+| `folder.rename`         | Переименовывает папку                                            | `None`             |
+| `project.root_folder`   | Информация о корневой папке проекта                              | `dict`             |
+| `project.root_folder_id`| UUID корневой папки проекта                                      | `UUID`             |
+| `project.get_list`      | Список проектов                                                  | `list[dict]`       |
+| `project.info`          | Информация о проекте                                             | `dict`             |
+| `project.users`         | Список пользователей проекта                                     | `list[dict]`       |
+| `project.roles`         | Список ролей проекта                                             | `list[dict]`       |
+| `project.users_permissions` | Список прав пользователя в проекте                          | `list[str]`        |
+| `company.users_list`    | Список пользователей компании                                    | `list[dict]`       |
+| `company.roles_list`    | Список ролей компании                                            | `list[dict]`       |
+| `version.get_list`      | Список версий файла                                              | `list[dict]`       |
+| `version.count`         | Количество версий файла                                          | `int`              |
+| `version.create`        | Создает новую версию объекта                                     | `UUID`             |
+| `file.get_object_upload`| Получает тикет на загрузку объекта                               | `dict`             |
+| `file.commit_uploading` | Завершает загрузку объекта                                       | `None`             |
+| `file.upload`           | Загружает файл                                                   | `dict` или `None`  |
+

sgnl_api-0.0.3/README.md

@@ -0,0 +1,64 @@
+# <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`         | Список файлов в директории                                       | `list[dict]`       |
+| `item.count`            | Количество файлов в директории                                   | `int`              |
+| `item.create_file`      | Создает новый файл с версией                                     | `UUID`             |
+| `item.create_link`      | Создает новую ссылку                                             | `UUID`             |
+| `item.get_link`         | Получает ссылку для загрузки файла                               | `dict`             |
+| `item.add_version`      | Добавляет новую версию к существующему файлу                     | `None`             |
+| `folder.get_list`       | Список дочерних папок                                            | `list[dict]`       |
+| `folder.create`         | Создает новую папку                                              | `UUID`             |
+| `folder.rename`         | Переименовывает папку                                            | `None`             |
+| `project.root_folder`   | Информация о корневой папке проекта                              | `dict`             |
+| `project.root_folder_id`| UUID корневой папки проекта                                      | `UUID`             |
+| `project.get_list`      | Список проектов                                                  | `list[dict]`       |
+| `project.info`          | Информация о проекте                                             | `dict`             |
+| `project.users`         | Список пользователей проекта                                     | `list[dict]`       |
+| `project.roles`         | Список ролей проекта                                             | `list[dict]`       |
+| `project.users_permissions` | Список прав пользователя в проекте                          | `list[str]`        |
+| `company.users_list`    | Список пользователей компании                                    | `list[dict]`       |
+| `company.roles_list`    | Список ролей компании                                            | `list[dict]`       |
+| `version.get_list`      | Список версий файла                                              | `list[dict]`       |
+| `version.count`         | Количество версий файла                                          | `int`              |
+| `version.create`        | Создает новую версию объекта                                     | `UUID`             |
+| `file.get_object_upload`| Получает тикет на загрузку объекта                               | `dict`             |
+| `file.commit_uploading` | Завершает загрузку объекта                                       | `None`             |
+| `file.upload`           | Загружает файл                                                   | `dict` или `None`  |
+

{sgnl_api-0.0.2 → sgnl_api-0.0.3}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r", encoding="utf-8") as fh:
 
 setup(
     name='sgnl-api',
-    version='0.0.2',
+    version='0.0.3',
     author='Igor Gritsyuk',
     author_email='gritsyuk.igor@gmail.com',
     description='Asynchronous python wrapper over API sgnl.pro',

{sgnl_api-0.0.2 → sgnl_api-0.0.3}/sgnl_api/docs_api.py

@@ -140,6 +140,14 @@ class DocsApi:
                 take: int = 100,
                 skip: int = 0
         ) -> list[dict]:
+            """
+            Required scopes: docs:item:list
+            :param folder_id: UUID of the folder
+            :param deleted: If true, returns deleted items
+            :param take: Number of items to return
+            :param skip: Number of items to skip
+            :return: Returns a folder`s not nested items list.
+            """
             return await self.api._make_request(
                 method='GET',
                 url=f'{self.api.base_url}/items',
@@ -158,6 +166,12 @@ class DocsApi:
                 folder_id: UUID,
                 deleted: bool = False
         ) -> int:
+            """
+            Required scopes: docs:item:list
+            :param folder_id: UUID of the folder
+            :param deleted: If true, returns deleted items
+            :return: Returns a count items in folder`s not nested items list.
+            """
             return await self.api._make_request(
                 method='GET',
                 url=f'{self.api.base_url}/items/count',
@@ -168,31 +182,21 @@ class DocsApi:
                 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(
+        @extract_key_from_response(key='data')
+        async def create_file(
                 self,
                 name: str,
                 folder_id: UUID,
                 version_id: UUID
-        ) -> dict:
+        ) -> UUID:
+            """
+            Creates a new File item with a version and attaches it to the item. Returns the id of the created item.
+            Required scopes: docs:item:create
+            :param name: Name of item to create
+            :param folder_id: UUID of the folder
+            :param version_id: UUID of the version
+            :return: UUID of the created item
+            """
             return await self.api._make_request(
                 method='PUT',
                 url=f'{self.api.base_url}/items/file',
@@ -204,12 +208,21 @@ class DocsApi:
                 headers=self.api._get_headers()
             )
 
+        @extract_key_from_response(key='data')
         async def create_link(
                 self,
                 name: str,
                 folder_id: UUID,
                 version_id: UUID
-        ) -> dict:
+        ) -> UUID:
+            """
+            Creates a new Link item. Returns the id of the created item.
+            Required scopes: docs:item:create
+            :param name:
+            :param folder_id:
+            :param version_id:
+            :return: UUID of the created link.
+            """
             return await self.api._make_request(
                 method='PUT',
                 url=f'{self.api.base_url}/items/link',
@@ -221,16 +234,49 @@ class DocsApi:
                 headers=self.api._get_headers()
             )
 
-        async def new_version(
+        async def get_link(
                 self,
                 item_id: UUID,
-                version_id: UUID
+                version_id: UUID,
+                file_name: str = None
         ) -> dict:
+            """
+            Required scopes: docs:item:read.
+            :param item_id: Item UUID
+            :param version_id: Version UUID
+            :param file_name: ...
+            :return: Returns S3 download link
+            """
+            params = {
+                'itemId': item_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 add_version(
+                self,
+                item_id: UUID,
+                version_id: UUID
+        ) -> None:
+            """
+            Attaches a version to an existing item.
+            Required scopes: docs:version:create
+            :param item_id:
+            :param version_id:
+            :return: None
+            """
             return await self.api._make_request(
                 method='PUT',
                 url=f'{self.api.base_url}/items/versions',
                 json={
-                    'folderId': item_id,
+                    'itemId': item_id,
                     'versionId': version_id
                 },
                 headers=self.api._get_headers()
@@ -245,6 +291,12 @@ class DocsApi:
                 folder_id: UUID,
                 deleted: bool = False
         ) -> list[dict]:
+            """
+            Required scopes: docs:folder:list
+            :param folder_id: UUID of the folder
+            :param deleted: If true, returns deleted items
+            :return: Returns a list of folder`s children.
+            """
             return await self.api._make_request(
                 method='GET',
                 url=f'{self.api.base_url}/folders/{folder_id}/children',
@@ -254,11 +306,19 @@ class DocsApi:
                 headers=self.api._get_headers()
             )
 
+        @extract_key_from_response(key='data')
         async def create(
                 self,
                 parent_id: UUID,
                 name: str = 'new folder from api'
-        ) -> dict:
+        ) -> UUID:
+            """
+            Creates a new folder.
+            Required scopes: docs:folder:create
+            :param parent_id: UUID of the parent folder
+            :param name: Name of the folder
+            :return: UUID of the created folder.
+            """
             return await self.api._make_request(
                 method='PUT',
                 url=f'{self.api.base_url}/folders',
@@ -269,11 +329,18 @@ class DocsApi:
                 headers=self.api._get_headers()
             )
 
-        async def update(
+        async def rename(
                 self,
                 folder_id: UUID,
                 name: str
-        ) -> dict:
+        ) -> None:
+            """
+            Updates a folder - rename
+            Required scopes: docs:folder:update
+            :param folder_id: UUID of the folder
+            :param name: New name of the folder
+            :return: None
+            """
             return await self.api._make_request(
                 method='PATCH',
                 url=f'{self.api.base_url}/folders',
@@ -288,9 +355,12 @@ class DocsApi:
         def __init__(self, api: 'DocsApi'):
             self.api = api
 
-        async def root_folder(
-                self,
-                project_id: UUID) -> dict:
+        async def root_folder(self, project_id: UUID) -> dict:
+            """
+            Required scopes: project:read
+            :param project_id: UUID of the project
+            :return: Returns information about a project in Docs.
+            """
             return await self.api._make_request(
                 method='GET',
                 url=f'{self.api.base_url}/docs/projects/{project_id}',
@@ -298,7 +368,12 @@ class DocsApi:
             )
 
         @extract_key_from_response(key='root_folder_id')
-        async def root_folder_id(self, project_id: UUID) -> dict:
+        async def root_folder_id(self, project_id: UUID) -> UUID:
+            """
+            Required scopes: project:read
+            :param project_id: UUID of the project
+            :return:  Returns root folder UUID of the project.
+            """
             return await self.root_folder(project_id)
 
         async def get_list(
@@ -306,6 +381,12 @@ class DocsApi:
                 take: int = 100,
                 skip: int = 0
         ) -> list[dict]:
+            """
+            Required scopes: project:list
+            :param take: The number of items to return. Default value is 100. Maximum value is 200.
+            :param skip: The number of items to skip. Default value is 0.
+            :return: Returns a list of projects.
+            """
             return await self.api._make_request(
                 method='GET',
                 url=f'{self.api.base_url}/projects',
@@ -320,6 +401,11 @@ class DocsApi:
                 self,
                 project_id: UUID
         ) -> dict:
+            """
+            Required scopes: project:read
+            :param project_id: UUID of the project
+            :return: Returns information about a project in Docs.
+            """
             return await self.api._make_request(
                 method='GET',
                 url=f'{self.api.base_url}/projects/{project_id}',
@@ -332,6 +418,13 @@ class DocsApi:
                 take: int = 100,
                 skip: int = 0
         ) -> list[dict]:
+            """
+            Required scopes: project:user:list
+            :param project_id: Project UUID
+            :param take: The number of items to return. Default value is 100. Maximum value is 200
+            :param skip: The number of items to skip. Default value is 0.
+            :return: Returns a list of users associated with a given project.
+            """
             return await self.api._make_request(
                 method='GET',
                 url=f'{self.api.base_url}/projects/{project_id}/users',
@@ -348,6 +441,13 @@ class DocsApi:
                 take: int = 100,
                 skip: int = 0
         ) -> list[dict]:
+            """
+            Required scopes: project:role:list.
+            :param project_id: Project UUID
+            :param take: The number of items to return. Default value is 100. Maximum value is 200
+            :param skip: The number of items to skip. Default value is 0
+            :return: Returns a list of roles associated with a given project.
+            """
             return await self.api._make_request(
                 method='GET',
                 url=f'{self.api.base_url}/projects/{project_id}/roles',
@@ -358,11 +458,18 @@ class DocsApi:
                 headers=self.api._get_headers()
             )
 
+        @extract_key_from_response(key='roles')
         async def users_permissions(
                 self,
                 project_id: UUID,
                 user_id: UUID
-        ) -> dict:
+        ) -> list[str]:
+            """
+            Required scopes: project:user:read
+            :param project_id: Project UUID
+            :param user_id: User UUID
+            :return: Returns information about a specific user's permissions in a project.
+            """
             return await self.api._make_request(
                 method='GET',
                 url=f'{self.api.base_url}/projects/{project_id}/users/{user_id}/permission',
@@ -374,6 +481,12 @@ class DocsApi:
             self.api = api
 
         async def users_list(self, take: int = 100, skip: int = 0) -> list[dict]:
+            """
+            Required scopes: company:user:list
+            :param take: The number of items to return. Default value is 100. Maximum value is 200.
+            :param skip: The number of items to skip. Default value is 0.
+            :return: Returns a list of users associated with a company.
+            """
             return await self.api._make_request(
                 method='GET',
                 url=f'{self.api.base_url}/company/users',
@@ -385,6 +498,12 @@ class DocsApi:
             )
 
         async def roles_list(self, take: int = 100, skip: int = 0) -> list[dict]:
+            """
+            Required scopes: company:role:list
+            :param take: The number of items to return. Default value is 100. Maximum value is 200.
+            :param skip: The number of items to skip. Default value is 0.
+            :return: Returns a list of roles associated with a company.
+            """
             return await self.api._make_request(
                 method='GET',
                 url=f'{self.api.base_url}/company/roles',
@@ -399,12 +518,20 @@ class DocsApi:
         def __init__(self, api: 'DocsApi'):
             self.api = api
 
-        async def list(
+        async def get_list(
                 self,
                 item_id: UUID,
                 take: int = 100,
                 skip: int = 0
         ) -> list[dict]:
+            """
+            Returns a list of versions of item
+            Required scopes: docs:version:list
+            :param item_id: Item UUID
+            :param take: The number of items to return. Default value is 100. Maximum value is 200.
+            :param skip: The number of items to skip. Default value is 0.
+            :return: list of versions of item
+            """
             return await self.api._make_request(
                 method='GET',
                 url=f'{self.api.base_url}/versions',
@@ -420,7 +547,13 @@ class DocsApi:
         async def count(
                 self,
                 item_id: UUID
-        ) -> dict:
+        ) -> int:
+            """
+            Returns the count of item`s versions.
+            Required scopes: docs:version:list
+            :param item_id: Item UUID
+            :return: count items
+            """
             return await self.api._make_request(
                 method='GET',
                 url=f'{self.api.base_url}/versions',
@@ -430,13 +563,22 @@ class DocsApi:
                 headers=self.api._get_headers()
             )
 
-        async def new(
+        @extract_key_from_response(key="data")
+        async def create(
                 self,
                 *,
                 object_id: UUID,
                 project_id: UUID,
                 name: str
-        ) -> dict:
+        ) -> UUID:
+            """
+            Creates a new version of an object. Returns the id of the created version.
+            Required scopes: docs:version:create
+            :param object_id: UUID of the object
+            :param project_id: UUID of the project
+            :param name: ...
+            :return: UUID of the created version
+            """
             return await self.api._make_request(
                 method='POST',
                 url=f'{self.api.base_url}/versions',
@@ -458,6 +600,14 @@ class DocsApi:
                 mime_type: str,
                 size: int
         ) -> dict:
+            """
+            Returns the object upload ticket. Each object must be committed.
+            Required scopes: docs:object:create
+            :param project_id: UUID of the project
+            :param mime_type: mime type of the file
+            :param size: file size in bytes
+            :return: dict: Object upload ticket
+            """
             return await self.api._make_request(
                 method='PUT',
                 url=f'{self.api.base_url}/objects',
@@ -472,7 +622,13 @@ class DocsApi:
         async def commit_uploading(
                 self,
                 object_id: UUID
-        ) -> dict:
+        ) -> None:
+            """
+            Commiting object upload after put it in S3.
+            Required scopes: docs:object:create
+            :param object_id: UUID S3 object
+            :return: None
+            """
             return await self.api._make_request(
                 method='POST',
                 url=f'{self.api.base_url}/objects/{object_id}/uploading/commit',

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

@@ -0,0 +1,83 @@
+Metadata-Version: 2.1
+Name: sgnl-api
+Version: 0.0.3
+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`         | Список файлов в директории                                       | `list[dict]`       |
+| `item.count`            | Количество файлов в директории                                   | `int`              |
+| `item.create_file`      | Создает новый файл с версией                                     | `UUID`             |
+| `item.create_link`      | Создает новую ссылку                                             | `UUID`             |
+| `item.get_link`         | Получает ссылку для загрузки файла                               | `dict`             |
+| `item.add_version`      | Добавляет новую версию к существующему файлу                     | `None`             |
+| `folder.get_list`       | Список дочерних папок                                            | `list[dict]`       |
+| `folder.create`         | Создает новую папку                                              | `UUID`             |
+| `folder.rename`         | Переименовывает папку                                            | `None`             |
+| `project.root_folder`   | Информация о корневой папке проекта                              | `dict`             |
+| `project.root_folder_id`| UUID корневой папки проекта                                      | `UUID`             |
+| `project.get_list`      | Список проектов                                                  | `list[dict]`       |
+| `project.info`          | Информация о проекте                                             | `dict`             |
+| `project.users`         | Список пользователей проекта                                     | `list[dict]`       |
+| `project.roles`         | Список ролей проекта                                             | `list[dict]`       |
+| `project.users_permissions` | Список прав пользователя в проекте                          | `list[str]`        |
+| `company.users_list`    | Список пользователей компании                                    | `list[dict]`       |
+| `company.roles_list`    | Список ролей компании                                            | `list[dict]`       |
+| `version.get_list`      | Список версий файла                                              | `list[dict]`       |
+| `version.count`         | Количество версий файла                                          | `int`              |
+| `version.create`        | Создает новую версию объекта                                     | `UUID`             |
+| `file.get_object_upload`| Получает тикет на загрузку объекта                               | `dict`             |
+| `file.commit_uploading` | Завершает загрузку объекта                                       | `None`             |
+| `file.upload`           | Загружает файл                                                   | `dict` или `None`  |
+

sgnl_api-0.0.2/PKG-INFO

@@ -1,82 +0,0 @@
-Metadata-Version: 2.1
-Name: sgnl-api
-Version: 0.0.2
-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.2/README.md

@@ -1,63 +0,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.2/sgnl_api.egg-info/PKG-INFO

@@ -1,82 +0,0 @@
-Metadata-Version: 2.1
-Name: sgnl-api
-Version: 0.0.2
-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`               | Загрузка объекта полный цикл            |