dubidoc 0.1.0__tar.gz → 0.1.2__tar.gz

{dubidoc-0.1.0 → dubidoc-0.1.2}/LICENSE

@@ -18,4 +18,4 @@ 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.
+SOFTWARE.

{dubidoc-0.1.0 → dubidoc-0.1.2}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: dubidoc
-Version: 0.1.0
+Version: 0.1.2
 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
+Project-URL: Changelog, https://github.com/DmytroLitvinov/python-dubidoc/blob/main/CHANGELOG.md
 Keywords: dubidoc,Ukraine,🇺🇦,api,dubidoc.com.ua
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Web Environment
@@ -44,6 +44,9 @@ Requires-Dist: requests
 
 Python API wrapper around Dubidoc API. Feel free to contribute and make it better! 🚀
 
+**NOTE**: Since it is rearly release, some of the API endpoints may not be implemented yet. If you need some specific endpoint, feel free to create an issue or pull request.
+Also, library can be changed in the future, so be careful with the updates as for now.
+
 ## Installation
 
 ```sh

{dubidoc-0.1.0 → dubidoc-0.1.2}/README.md

@@ -15,6 +15,9 @@
 
 Python API wrapper around Dubidoc API. Feel free to contribute and make it better! 🚀
 
+**NOTE**: Since it is rearly release, some of the API endpoints may not be implemented yet. If you need some specific endpoint, feel free to create an issue or pull request.
+Also, library can be changed in the future, so be careful with the updates as for now.
+
 ## Installation
 
 ```sh
@@ -40,4 +43,4 @@ print(documents)
 
 ## License
 
-This project is licensed under the terms of the [MIT license](https://github.com/DmytroLitvinov/python-dubidoc/blob/master/LICENSE).
+This project is licensed under the terms of the [MIT license](https://github.com/DmytroLitvinov/python-dubidoc/blob/master/LICENSE).

dubidoc-0.1.2/dubidoc/__init__.py

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

dubidoc-0.1.2/dubidoc/_modules/__init__.py

@@ -0,0 +1,7 @@
+from .access_token import *
+from .authentication import *
+from .device import *
+from .document import *
+from .document_link import *
+from .download import *
+from .participant import *

{dubidoc-0.1.0 → dubidoc-0.1.2}/dubidoc/_modules/access_token.py

@@ -1,5 +1,7 @@
 from dubidoc.enum import HttpMethod
 
+__all__ = ('AccessTokenAPI',)
+
 
 class AccessTokenAPI:
     PATH = 'access-tokens'
@@ -20,7 +22,7 @@ class AccessTokenAPI:
         :param title:
         """
         path = self.PATH
-        return self.client.make_request(HttpMethod.POST, path, body={"title": title})
+        return self.client.make_request(HttpMethod.POST, path, body={'title': title})
 
     def revoke_token(self, token_id):
         """
@@ -28,4 +30,4 @@ class AccessTokenAPI:
         :param token_id:
         """
         path = f'{self.PATH}/{token_id}'
-        return self.client.make_request(HttpMethod.DELETE, path)
+        return self.client.make_request(HttpMethod.DELETE, path)

{dubidoc-0.1.0 → dubidoc-0.1.2}/dubidoc/_modules/authentication.py

@@ -1,8 +1,10 @@
 from dubidoc.enum import HttpMethod
 
 
-class AuthenticationAPI:
+__all__ = ('AuthenticationAPI',)
+
 
+class AuthenticationAPI:
     def __init__(self, client):
         self.client = client
 
@@ -12,7 +14,7 @@ class AuthenticationAPI:
         Description: Метод відправки тимчасового коду для авторизації через email
         """
         path = self.PATH
-        body = {"login": login}
+        body = {'login': login}
         return self.client.make_request(HttpMethod.POST, path, body)
 
     def get_token(self, login, code):
@@ -21,10 +23,7 @@ class AuthenticationAPI:
         Description: Метод для отримання токену користувача на основі email та тимчасового коду авторизації
         """
         path = 'auth/get-token'
-        body = {
-            "login": login,
-            "code": code
-        }
+        body = {'login': login, 'code': code}
         return self.client.make_request(HttpMethod.POST, path, body)
 
     def refresh(self, refresh_token):
@@ -34,8 +33,6 @@ class AuthenticationAPI:
         :param token_id:
         :return:
         """
-        path = f'token/refresh'
-        body = {
-            "refresh_token": refresh_token
-        }
-        return self.client.delete(HttpMethod.POST, path, body)
+        path = 'token/refresh'
+        body = {'refresh_token': refresh_token}
+        return self.client.delete(HttpMethod.POST, path, body)

{dubidoc-0.1.0 → dubidoc-0.1.2}/dubidoc/_modules/device.py

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

{dubidoc-0.1.0 → dubidoc-0.1.2}/dubidoc/_modules/document.py

@@ -1,6 +1,9 @@
 from dubidoc.enum import HttpMethod
 
 
+__all__ = ('DocumentAPI',)
+
+
 class DocumentAPI:
     PATH = 'documents'
 
@@ -11,17 +14,19 @@ class DocumentAPI:
         return self.client.make_request(HttpMethod.GET, self.PATH)
 
     def create(self, body, organization_id=None):
+        """
+        filename — назва файлу з розширенням (опціонально використовується для додаткової валідації)
+        file — base64
+        title — відображувана назва в кабінеті користувача, емейл листі тощо (рекомендується передавати назву файлу без розширення, хоча це не критично)
+        """
         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):
+    def edit(self, document_id, body):
         path = f'{self.PATH}/{document_id}'
-        body = {
-            "title": title,
-        }
         return self.client.make_request(HttpMethod.PUT, path, body)
 
     def delete(self, document_id):

{dubidoc-0.1.0 → dubidoc-0.1.2}/dubidoc/_modules/document_link.py

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

{dubidoc-0.1.0 → dubidoc-0.1.2}/dubidoc/_modules/download.py

@@ -1,6 +1,9 @@
 from dubidoc.enum import HttpMethod
 
 
+__all__ = ('DownloadAPI',)
+
+
 class DownloadAPI:
     PATH = 'downloads'
 
@@ -18,4 +21,3 @@ class DownloadAPI:
     def check_status(self, download_id):
         path = f'{self.PATH}/{download_id}/status'
         return self.client.make_request(HttpMethod.GET, path)
-

dubidoc-0.1.2/dubidoc/_modules/organization.py

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

dubidoc-0.1.2/dubidoc/_modules/organization_user.py

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

{dubidoc-0.1.0 → dubidoc-0.1.2}/dubidoc/_modules/participant.py

@@ -1,8 +1,9 @@
 from dubidoc.enum import HttpMethod
 
+__all__ = ('ParticipantAPI',)
 
-class ParticipantAPI:
 
+class ParticipantAPI:
     def __init__(self, client):
         self.client = client
 
@@ -17,4 +18,7 @@ class ParticipantAPI:
         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, )
+        return self.client.make_request(
+            HttpMethod.DELETE,
+            path,
+        )

dubidoc-0.1.2/dubidoc/_modules/storecode.py

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

{dubidoc-0.1.0 → dubidoc-0.1.2}/dubidoc/client.py

@@ -4,8 +4,15 @@ from urllib.parse import urljoin
 import requests
 
 from dubidoc import __version__
-from dubidoc._modules import AccessTokenAPI, AuthenticationAPI, DeviceAPI, DocumentAPI, DocumentLinkAPI, ParticipantAPI, \
-    DownloadAPI
+from dubidoc._modules import (
+    AccessTokenAPI,
+    AuthenticationAPI,
+    DeviceAPI,
+    DocumentAPI,
+    DocumentLinkAPI,
+    ParticipantAPI,
+    DownloadAPI,
+)
 from dubidoc.enum import HttpMethod
 
 
@@ -18,22 +25,22 @@ class DubidocAPIClient:
     - https://docs-stage.navkolo.one/auth - staging URL
     """
 
-    API_VERSION = "v1"
+    API_VERSION = 'v1'
     DEFAULT_HEADERS = {
-        "accept": "application/json",
-        "content-type": "application/json",
-        "user-agent": f"python-dubidoc/{__version__} | (https://github.com/DmytroLitvinov/python-dubidoc)",
+        '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"):
+    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"
+        if environment == 'stage':
+            self.base_url = 'https://docs-stage.navkolo.one'
         else:
-            self.base_url = "https://my.dubidoc.com.ua"
+            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.prefix = f'api/api/{self.API_VERSION}/'
         self.endpoint = urljoin(self.base_url, self.prefix)
 
         # Modules
@@ -42,7 +49,7 @@ class DubidocAPIClient:
         self.participant_api = ParticipantAPI(self)
         self.download_api = DownloadAPI(self)
 
-        if environment == "stage":
+        if environment == 'stage':
             self.access_token_api = AccessTokenAPI(self)
             self.authentication_api = AuthenticationAPI(self)
             self.device_api = DeviceAPI(self)
@@ -53,7 +60,7 @@ class DubidocAPIClient:
 
     def _get_headers(self):
         headers = self.DEFAULT_HEADERS.copy()
-        headers.update({"X-Access-Token": f"{self.api_token}"})
+        headers.update({'X-Access-Token': f'{self.api_token}'})
         return headers
 
     def make_request(self, method: HttpMethod, path: str, body: dict = {}):
@@ -67,9 +74,9 @@ class DubidocAPIClient:
         url = urljoin(self.endpoint, path)
         headers = self._get_headers()
 
-        logger.debug(f"Making {method.value} request to {url} with headers {headers} and body {body}")
+        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}")
+        logger.debug(f'Received response with status code {response.status_code} and body {response.text}')
 
         return response.json()

dubidoc-0.1.2/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-0.1.2}/dubidoc.egg-info/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: dubidoc
-Version: 0.1.0
+Version: 0.1.2
 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
+Project-URL: Changelog, https://github.com/DmytroLitvinov/python-dubidoc/blob/main/CHANGELOG.md
 Keywords: dubidoc,Ukraine,🇺🇦,api,dubidoc.com.ua
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Web Environment
@@ -44,6 +44,9 @@ Requires-Dist: requests
 
 Python API wrapper around Dubidoc API. Feel free to contribute and make it better! 🚀
 
+**NOTE**: Since it is rearly release, some of the API endpoints may not be implemented yet. If you need some specific endpoint, feel free to create an issue or pull request.
+Also, library can be changed in the future, so be careful with the updates as for now.
+
 ## Installation
 
 ```sh

{dubidoc-0.1.0 → dubidoc-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "dubidoc"
-version = "0.1.0"
+version = "0.1.2"
 requires-python = ">=3.8"
 description = "Python SDK for dubidoc.com.ua API"
 readme = "README.md"
@@ -36,10 +36,7 @@ dependencies = [
 [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*"]
+Changelog = "https://github.com/DmytroLitvinov/python-dubidoc/blob/main/CHANGELOG.md"
 
 # Ruff
 # ----
@@ -54,6 +51,9 @@ indent-style = "space"
 skip-magic-trailing-comma = false
 line-ending = "auto"
 
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401", "F403"]
+
 # Mypy
 # ----
 

dubidoc-0.1.0/dubidoc/__init__.py

@@ -1,7 +0,0 @@
-"""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

@@ -1,7 +0,0 @@
-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/organization.py

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

dubidoc-0.1.0/dubidoc/_modules/organization_user.py

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

dubidoc-0.1.0/dubidoc/_modules/storecode.py

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

dubidoc-0.1.0/dubidoc/enum.py

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