dubidoc 0.1.0__tar.gz

dubidoc-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Dmytro Litvinov
+
+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.

dubidoc-0.1.0/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.1
+Name: dubidoc
+Version: 0.1.0
+Summary: Python SDK for dubidoc.com.ua API
+Maintainer-email: Dmytro Litvinov <me@dmytrolitvinov.com>
+License: MIT License
+Project-URL: Homepage, https://github.com/DmytroLitvinov/python-dubidoc
+Project-URL: Issues, https://github.com/DmytroLitvinov/python-dubidoc/issues
+Project-URL: Changelog, https://github.com/DmytroLitvinov/python-dubidoc/CHANGELOG.md
+Keywords: dubidoc,Ukraine,🇺🇦,api,dubidoc.com.ua
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+
+# Dubidoc API client ✍
+
+[![PyPI](https://img.shields.io/pypi/v/dubidoc?style=flat-square)](https://pypi.python.org/pypi/dubidoc/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dubidoc?style=flat-square)](https://pypi.python.org/pypi/dubidoc/)
+[![PyPI - License](https://img.shields.io/pypi/l/dubidoc?style=flat-square)](https://pypi.python.org/pypi/dubidoc/)
+
+---
+**Documentation**: [https://my.dubidoc.com.ua/api/api/v1/docs](https://my.dubidoc.com.ua/api/api/v1/docs)
+
+**Source Code**: [https://github.com/DmytroLitvinov/python-dubidoc](https://github.com/DmytroLitvinov/python-dubidoc)
+
+**PyPI**: [https://pypi.org/project/dubidoc/](https://pypi.org/project/dubidoc/)
+
+---
+
+Python API wrapper around Dubidoc API. Feel free to contribute and make it better! 🚀
+
+## Installation
+
+```sh
+pip install dubidoc
+```
+
+## Usage
+
+1) Request your token at [Dubidoc team](https://t.me/dmytro_dubilet/814)
+
+2) Use that token to initialize client:
+
+```python
+from dubidoc import DubidocAPIClient
+
+api_token = 'xxxxxxxxxxxxxxx'
+
+dubidoc = DubidocAPIClient(api_token)
+
+documents = dubidoc.document_api.list()
+print(documents)
+```
+
+## License
+
+This project is licensed under the terms of the [MIT license](https://github.com/DmytroLitvinov/python-dubidoc/blob/master/LICENSE).

dubidoc-0.1.0/README.md

@@ -0,0 +1,43 @@
+# Dubidoc API client ✍
+
+[![PyPI](https://img.shields.io/pypi/v/dubidoc?style=flat-square)](https://pypi.python.org/pypi/dubidoc/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dubidoc?style=flat-square)](https://pypi.python.org/pypi/dubidoc/)
+[![PyPI - License](https://img.shields.io/pypi/l/dubidoc?style=flat-square)](https://pypi.python.org/pypi/dubidoc/)
+
+---
+**Documentation**: [https://my.dubidoc.com.ua/api/api/v1/docs](https://my.dubidoc.com.ua/api/api/v1/docs)
+
+**Source Code**: [https://github.com/DmytroLitvinov/python-dubidoc](https://github.com/DmytroLitvinov/python-dubidoc)
+
+**PyPI**: [https://pypi.org/project/dubidoc/](https://pypi.org/project/dubidoc/)
+
+---
+
+Python API wrapper around Dubidoc API. Feel free to contribute and make it better! 🚀
+
+## Installation
+
+```sh
+pip install dubidoc
+```
+
+## Usage
+
+1) Request your token at [Dubidoc team](https://t.me/dmytro_dubilet/814)
+
+2) Use that token to initialize client:
+
+```python
+from dubidoc import DubidocAPIClient
+
+api_token = 'xxxxxxxxxxxxxxx'
+
+dubidoc = DubidocAPIClient(api_token)
+
+documents = dubidoc.document_api.list()
+print(documents)
+```
+
+## License
+
+This project is licensed under the terms of the [MIT license](https://github.com/DmytroLitvinov/python-dubidoc/blob/master/LICENSE).

dubidoc-0.1.0/dubidoc/__init__.py

@@ -0,0 +1,7 @@
+"""Top-level package for Dubidoc API wrapper."""
+
+__author__ = "Dmytro Litvinov"
+__email__ = "me@dmytrolitvinov.com"
+__version__ = "0.1.0"
+
+from .client import DubidocAPIClient

dubidoc-0.1.0/dubidoc/_modules/__init__.py

@@ -0,0 +1,7 @@
+from .access_token import AccessTokenAPI
+from .authentication import AuthenticationAPI
+from .device import DeviceAPI
+from .document import DocumentAPI
+from .document_link import DocumentLinkAPI
+from .download import DownloadAPI
+from .participant import ParticipantAPI

dubidoc-0.1.0/dubidoc/_modules/access_token.py

@@ -0,0 +1,31 @@
+from dubidoc.enum import HttpMethod
+
+
+class AccessTokenAPI:
+    PATH = 'access-tokens'
+
+    def __init__(self, client):
+        self.client = client
+
+    def get_tokens(self):
+        """
+        Отримати список всіх згенерованих Вами API-ключів (токенів)
+        """
+        path = self.PATH
+        return self.client.make_request(HttpMethod.GET, path)
+
+    def generate_token(self, title):
+        """
+        Генерування статичного API-ключа (токену) для доступу до API
+        :param title:
+        """
+        path = self.PATH
+        return self.client.make_request(HttpMethod.POST, path, body={"title": title})
+
+    def revoke_token(self, token_id):
+        """
+        Зробити обраний API-ключ (токен) недійсним
+        :param token_id:
+        """
+        path = f'{self.PATH}/{token_id}'
+        return self.client.make_request(HttpMethod.DELETE, path)

dubidoc-0.1.0/dubidoc/_modules/authentication.py

@@ -0,0 +1,41 @@
+from dubidoc.enum import HttpMethod
+
+
+class AuthenticationAPI:
+
+    def __init__(self, client):
+        self.client = client
+
+    def get_code(self, login):
+        """
+        Title: Отримати код авторизації
+        Description: Метод відправки тимчасового коду для авторизації через email
+        """
+        path = self.PATH
+        body = {"login": login}
+        return self.client.make_request(HttpMethod.POST, path, body)
+
+    def get_token(self, login, code):
+        """
+        Title: Отримати авторизаційний токен
+        Description: Метод для отримання токену користувача на основі email та тимчасового коду авторизації
+        """
+        path = 'auth/get-token'
+        body = {
+            "login": login,
+            "code": code
+        }
+        return self.client.make_request(HttpMethod.POST, path, body)
+
+    def refresh(self, refresh_token):
+        """
+        Title: Оновити авторизаційний токен
+        Description: Продовжити дію авторизаційного токену користувача на основі refresh токену
+        :param token_id:
+        :return:
+        """
+        path = f'token/refresh'
+        body = {
+            "refresh_token": refresh_token
+        }
+        return self.client.delete(HttpMethod.POST, path, body)

dubidoc-0.1.0/dubidoc/_modules/device.py

@@ -0,0 +1,24 @@
+from dubidoc.enum import HttpMethod
+
+
+class DeviceAPI:
+
+    def __init__(self, client):
+        self.client = client
+
+    def register(self, token):
+        """
+        Title: Зареєструвати пристрій для відправки сповіщень
+        Description: Зареєструвати device token який отриманий через Firebase Cloud Messaging для відправки нотифікацій користувачу
+        """
+        path = 'devices'
+        body = {"token": token}
+        return self.client.make_request(HttpMethod.POST, path, body)
+
+    def unregister(self, token):
+        """
+        Title: Відписати пристрій від отримання сповіщень
+        Description: Скасувати відправку сповіщень для device token
+        """
+        path = f'devices/{token}'
+        return self.client.make_request(HttpMethod.DELETE, path)

dubidoc-0.1.0/dubidoc/_modules/document.py

@@ -0,0 +1,51 @@
+from dubidoc.enum import HttpMethod
+
+
+class DocumentAPI:
+    PATH = 'documents'
+
+    def __init__(self, client):
+        self.client = client
+
+    def list(self):
+        return self.client.make_request(HttpMethod.GET, self.PATH)
+
+    def create(self, body, organization_id=None):
+        return self.client.make_request(HttpMethod.POST, self.PATH, body)
+
+    def get(self, document_id):
+        path = f'{self.PATH}/{document_id}'
+        return self.client.make_request(HttpMethod.GET, path)
+
+    def edit(self, document_id, title):
+        path = f'{self.PATH}/{document_id}'
+        body = {
+            "title": title,
+        }
+        return self.client.make_request(HttpMethod.PUT, path, body)
+
+    def delete(self, document_id):
+        """
+        Title: Видалення документа
+        Description: Увага, видалити документ можливо лише за умови, що він не був підписаний або надісланий отримувачу
+        """
+        path = f'{self.PATH}/{document_id}'
+        return self.client.make_request(HttpMethod.DELETE, path)
+
+    def download(self):
+        raise NotImplementedError
+
+    def unarchive(self):
+        raise NotImplementedError
+
+    def participants(self):
+        raise NotImplementedError
+
+    def sign(self):
+        raise NotImplementedError
+
+    def signatures(self):
+        raise NotImplementedError
+
+    def archive(self):
+        raise NotImplementedError

dubidoc-0.1.0/dubidoc/_modules/document_link.py

@@ -0,0 +1,16 @@
+from dubidoc.enum import HttpMethod
+
+
+class DocumentLinkAPI:
+    PATH = 'documents/{}/links'
+
+    def __init__(self, client):
+        self.client = client
+
+    def generate_public_link(self, document_id):
+        path = self.PATH.format(document_id)
+        return self.client.make_request(HttpMethod.POST, path)
+
+    def revoke_public_link(self, document_id):
+        path = self.PATH.format(document_id)
+        return self.client.make_request(HttpMethod.DELETE, path)

dubidoc-0.1.0/dubidoc/_modules/download.py

@@ -0,0 +1,21 @@
+from dubidoc.enum import HttpMethod
+
+
+class DownloadAPI:
+    PATH = 'downloads'
+
+    def __init__(self, client):
+        self.client = client
+
+    def bulk_uploads(self, body):
+        path = self.PATH
+        return self.client.make_request(HttpMethod.POST, path, body)
+
+    def download(self, download_id):
+        path = f'{self.PATH}/{download_id}/download'
+        return self.client.make_request(HttpMethod.GET, path)
+
+    def check_status(self, download_id):
+        path = f'{self.PATH}/{download_id}/status'
+        return self.client.make_request(HttpMethod.GET, path)
+

dubidoc-0.1.0/dubidoc/_modules/organization.py

@@ -0,0 +1 @@
+# TODO

dubidoc-0.1.0/dubidoc/_modules/organization_user.py

@@ -0,0 +1 @@
+# TODO

dubidoc-0.1.0/dubidoc/_modules/participant.py

@@ -0,0 +1,20 @@
+from dubidoc.enum import HttpMethod
+
+
+class ParticipantAPI:
+
+    def __init__(self, client):
+        self.client = client
+
+    def add_participant(self, document_id, body):
+        path = 'documents/{}/participants'.format(document_id)
+        return self.client.make_request(HttpMethod.POST, path, body)
+
+    def remove_participant(self, participant_id):
+        """
+        It sounds like it should be DELETE 'documents/{}/participants/{}', but
+        each participant has own unique id, so it should be 'participants/{}'.
+        You can retrieve participant_id from the response of 'add_participant' method.
+        """
+        path = 'participants/{}'.format(participant_id)
+        return self.client.make_request(HttpMethod.DELETE, path, )

dubidoc-0.1.0/dubidoc/_modules/storecode.py

@@ -0,0 +1 @@
+# TODO

dubidoc-0.1.0/dubidoc/client.py

@@ -0,0 +1,75 @@
+import logging
+from urllib.parse import urljoin
+
+import requests
+
+from dubidoc import __version__
+from dubidoc._modules import AccessTokenAPI, AuthenticationAPI, DeviceAPI, DocumentAPI, DocumentLinkAPI, ParticipantAPI, \
+    DownloadAPI
+from dubidoc.enum import HttpMethod
+
+
+logger = logging.getLogger('dubidoc')
+
+
+class DubidocAPIClient:
+    """
+    - https://my.dubidoc.com.ua/auth - production URL
+    - https://docs-stage.navkolo.one/auth - staging URL
+    """
+
+    API_VERSION = "v1"
+    DEFAULT_HEADERS = {
+        "accept": "application/json",
+        "content-type": "application/json",
+        "user-agent": f"python-dubidoc/{__version__} | (https://github.com/DmytroLitvinov/python-dubidoc)",
+    }
+
+    def __init__(self, api_token: str, environment: str = "stage"):
+        self.api_token = api_token
+        if environment == "stage":
+            self.base_url = "https://docs-stage.navkolo.one"
+        else:
+            self.base_url = "https://my.dubidoc.com.ua"
+        # FIXME: The prefix should be "api/v1" instead of "api/api/v1"
+        #  Dubidoc will notify when it will be fixed
+        self.prefix = f"api/api/{self.API_VERSION}/"
+        self.endpoint = urljoin(self.base_url, self.prefix)
+
+        # Modules
+        self.document_api = DocumentAPI(self)
+        self.document_link_api = DocumentLinkAPI(self)
+        self.participant_api = ParticipantAPI(self)
+        self.download_api = DownloadAPI(self)
+
+        if environment == "stage":
+            self.access_token_api = AccessTokenAPI(self)
+            self.authentication_api = AuthenticationAPI(self)
+            self.device_api = DeviceAPI(self)
+            # Not yet implemented anot probably not needed
+            # self.organization_user_api = OrganizationUserAPI(self)
+            # self.organization_api = OrganizationAPI(self)
+            # self.shortcode_api = ShortcodeAPI(self)
+
+    def _get_headers(self):
+        headers = self.DEFAULT_HEADERS.copy()
+        headers.update({"X-Access-Token": f"{self.api_token}"})
+        return headers
+
+    def make_request(self, method: HttpMethod, path: str, body: dict = {}):
+        """
+        Fetches the given path in the Dubidoc API.
+        :param method: HTTP method
+        :param path: Api path
+        :param body: body of request
+        :return: Serialized server response or error
+        """
+        url = urljoin(self.endpoint, path)
+        headers = self._get_headers()
+
+        logger.debug(f"Making {method.value} request to {url} with headers {headers} and body {body}")
+        # https://github.com/psf/requests/issues/3070
+        response = requests.request(method.value, url, headers=headers, json=body, timeout=10)
+        logger.debug(f"Received response with status code {response.status_code} and body {response.text}")
+
+        return response.json()

dubidoc-0.1.0/dubidoc/enum.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+
+class HttpMethod(Enum):
+    GET = "GET"
+    POST = "POST"
+    PUT = "PUT"
+    DELETE = "DELETE"

dubidoc-0.1.0/dubidoc.egg-info/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.1
+Name: dubidoc
+Version: 0.1.0
+Summary: Python SDK for dubidoc.com.ua API
+Maintainer-email: Dmytro Litvinov <me@dmytrolitvinov.com>
+License: MIT License
+Project-URL: Homepage, https://github.com/DmytroLitvinov/python-dubidoc
+Project-URL: Issues, https://github.com/DmytroLitvinov/python-dubidoc/issues
+Project-URL: Changelog, https://github.com/DmytroLitvinov/python-dubidoc/CHANGELOG.md
+Keywords: dubidoc,Ukraine,🇺🇦,api,dubidoc.com.ua
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+
+# Dubidoc API client ✍
+
+[![PyPI](https://img.shields.io/pypi/v/dubidoc?style=flat-square)](https://pypi.python.org/pypi/dubidoc/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dubidoc?style=flat-square)](https://pypi.python.org/pypi/dubidoc/)
+[![PyPI - License](https://img.shields.io/pypi/l/dubidoc?style=flat-square)](https://pypi.python.org/pypi/dubidoc/)
+
+---
+**Documentation**: [https://my.dubidoc.com.ua/api/api/v1/docs](https://my.dubidoc.com.ua/api/api/v1/docs)
+
+**Source Code**: [https://github.com/DmytroLitvinov/python-dubidoc](https://github.com/DmytroLitvinov/python-dubidoc)
+
+**PyPI**: [https://pypi.org/project/dubidoc/](https://pypi.org/project/dubidoc/)
+
+---
+
+Python API wrapper around Dubidoc API. Feel free to contribute and make it better! 🚀
+
+## Installation
+
+```sh
+pip install dubidoc
+```
+
+## Usage
+
+1) Request your token at [Dubidoc team](https://t.me/dmytro_dubilet/814)
+
+2) Use that token to initialize client:
+
+```python
+from dubidoc import DubidocAPIClient
+
+api_token = 'xxxxxxxxxxxxxxx'
+
+dubidoc = DubidocAPIClient(api_token)
+
+documents = dubidoc.document_api.list()
+print(documents)
+```
+
+## License
+
+This project is licensed under the terms of the [MIT license](https://github.com/DmytroLitvinov/python-dubidoc/blob/master/LICENSE).

dubidoc-0.1.0/dubidoc.egg-info/SOURCES.txt

@@ -0,0 +1,22 @@
+LICENSE
+README.md
+pyproject.toml
+dubidoc/__init__.py
+dubidoc/client.py
+dubidoc/enum.py
+dubidoc.egg-info/PKG-INFO
+dubidoc.egg-info/SOURCES.txt
+dubidoc.egg-info/dependency_links.txt
+dubidoc.egg-info/requires.txt
+dubidoc.egg-info/top_level.txt
+dubidoc/_modules/__init__.py
+dubidoc/_modules/access_token.py
+dubidoc/_modules/authentication.py
+dubidoc/_modules/device.py
+dubidoc/_modules/document.py
+dubidoc/_modules/document_link.py
+dubidoc/_modules/download.py
+dubidoc/_modules/organization.py
+dubidoc/_modules/organization_user.py
+dubidoc/_modules/participant.py
+dubidoc/_modules/storecode.py

dubidoc-0.1.0/dubidoc.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

dubidoc-0.1.0/dubidoc.egg-info/requires.txt

@@ -0,0 +1 @@
+requests

dubidoc-0.1.0/dubidoc.egg-info/top_level.txt

@@ -0,0 +1 @@
+dubidoc

dubidoc-0.1.0/pyproject.toml

@@ -0,0 +1,72 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "dubidoc"
+version = "0.1.0"
+requires-python = ">=3.8"
+description = "Python SDK for dubidoc.com.ua API"
+readme = "README.md"
+keywords = ["dubidoc", "Ukraine", "🇺🇦", "api", "dubidoc.com.ua"]
+maintainers = [
+    {name = "Dmytro Litvinov", email = "me@dmytrolitvinov.com"}
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+license = {text = "MIT License"}
+dependencies = [
+    "requests"
+]
+
+[project.urls]
+Homepage = "https://github.com/DmytroLitvinov/python-dubidoc"
+Issues = "https://github.com/DmytroLitvinov/python-dubidoc/issues"
+Changelog = "https://github.com/DmytroLitvinov/python-dubidoc/CHANGELOG.md"
+
+[tool.setuptools.packages.find]
+include = ["dubidoc*"]
+
+# Ruff
+# ----
+[tool.ruff]
+src = ["dubidoc"]
+line-length = 120
+indent-width = 4
+
+[tool.ruff.format]
+quote-style = "single"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+# Mypy
+# ----
+
+[tool.mypy]
+files = "."
+
+# Use strict defaults
+strict = true
+warn_unreachable = true
+warn_no_return = true
+
+[[tool.mypy.overrides]]
+# Don't require test functions to include types
+module = "tests.*"
+allow_untyped_defs = true
+disable_error_code = "attr-defined"

dubidoc-0.1.0/setup.cfg

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