Prepare for 1.7.0

Author: bodrovis

Pipfile

@@ -10,7 +10,7 @@ pytest-vcr = "~=1.0.2"
 pytest-cov = "~=4.0"
 pylint = "~= 2.15"
 pytest-pylint = "~= 0.19"
-mypy = "~= 0.982"
+mypy = "~= 0.991"
 python-dotenv = "~= 0.21"
 autopep8 = "~= 2.0"
 importlib-metadata = "*"

Pipfile.lock

@@ -7,6 +7,7 @@ <h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
   <li><a href="{{ pathto('api/comments') }}">Comments</a></li>
   <li><a href="{{ pathto('api/contributors') }}">Contributors</a></li>
   <li><a href="{{ pathto('api/files') }}">Files</a></li>
+  <li><a href="{{ pathto('api/jwt') }}">JWT</a></li>
   <li><a href="{{ pathto('api/keys') }}">Keys</a></li>
   <li><a href="{{ pathto('api/languages') }}">Languages</a></li>
   <li><a href="{{ pathto('api/orders') }}">Orders</a></li>

docs/_templates/globaltoc.html

@@ -3,6 +3,16 @@
 Changelog
 =========
 
+1.7.0 (30-Nov-2022)
+-------------------
+
+* Added support for the `JWT endpoint <https://developers.lokalise.com/reference/get-ota-jwt>`_.
+
+.. code-block:: python
+
+  response = client.jwt()
+  response.jwt # => "eyJ0eXAiOiJK..."
+
 1.6.0 (05-Oct-2022)
 -------------------
 

docs/additional_info/changelog.rst

@@ -0,0 +1,16 @@
+JWT endpoint
+============
+
+Get OTA JWT
+-----------
+
+.. py:function:: jwt()
+
+  :return: JWT model
+
+Example:
+
+.. code-block:: python
+
+  response = client.jwt()
+  response.jwt # => "eyJ0eXAiOiJK..."

docs/api/jwt.rst

@@ -47,6 +47,7 @@ Usage
    api/comments
    api/contributors
    api/files
+   api/jwt
    api/keys
    api/languages
    api/orders

docs/index.rst

@@ -4,4 +4,4 @@
 This module contains plugin metadata.
 """
 
-__version__: str = "1.6.0"
+__version__: str = "1.7.0"

lokalise/_version.py

@@ -0,0 +1,35 @@
+"""
+lokalise.base_client
+~~~~~~~~~~~~~~~~~~~~
+This module contains base API client definition.
+"""
+from typing import Optional, Union
+
+
+class BaseClient:
+    """Base client used to send API requests.
+    """
+
+    def __init__(self,
+                 token: str,
+                 connect_timeout: Optional[Union[int, float]] = None,
+                 read_timeout: Optional[Union[int, float]] = None,
+                 enable_compression: Optional[bool] = False) -> None:
+        """Instantiate a new Lokalise API client.
+
+        :param str token: Your Lokalise API token.
+        :param connect_timeout: (optional) Server connection timeout
+        (the value is in seconds). By default, the client will wait indefinitely.
+        :type connect_timeout: int or float
+        :param read_timeout: (optional) Server read timeout
+        (the value is in seconds). By default, the client will wait indefinitely.
+        :type read_timeout: int or float
+        :param enable_compression: (optional) Whether to enable gzip compression.
+        By default it's off.
+        :type enable_compression: bool
+        """
+        self.token = token
+        self.connect_timeout = connect_timeout
+        self.read_timeout = read_timeout
+        self.enable_compression = enable_compression
+        self.token_header = 'X-Api-Token'

lokalise/base_client.py

@@ -6,6 +6,7 @@
 from typing import Any, Optional, Union, Dict, Callable, List
 import importlib
 from lokalise.utils import snake_to_camel
+from .base_client import BaseClient
 from .collections.branches import BranchesCollection
 from .collections.comments import CommentsCollection
 from .collections.contributors import ContributorsCollection
@@ -30,6 +31,7 @@
 from .models.branch import BranchModel
 from .models.comment import CommentModel
 from .models.contributor import ContributorModel
+from .models.jwt import JwtModel
 from .models.key import KeyModel
 from .models.language import LanguageModel
 from .models.order import OrderModel
@@ -49,7 +51,7 @@
 from .models.team_user_billing_details import TeamUsersBillingDetailsModel
 
 
-class Client:
+class Client(BaseClient):
     """Client used to send API requests.
 
     Usage:
@@ -59,30 +61,6 @@ class Client:
         client.projects()
     """
 
-    def __init__(self,
-                 token: str,
-                 connect_timeout: Optional[Union[int, float]] = None,
-                 read_timeout: Optional[Union[int, float]] = None,
-                 enable_compression: Optional[bool] = False) -> None:
-        """Instantiate a new Lokalise API client.
-
-        :param str token: Your Lokalise API token.
-        :param connect_timeout: (optional) Server connection timeout
-        (the value is in seconds). By default, the client will wait indefinitely.
-        :type connect_timeout: int or float
-        :param read_timeout: (optional) Server read timeout
-        (the value is in seconds). By default, the client will wait indefinitely.
-        :type read_timeout: int or float
-        :param enable_compression: (optional) Whether to enable gzip compression.
-        By default it's off.
-        :type enable_compression: bool
-        """
-        self.token = token
-        self.connect_timeout = connect_timeout
-        self.read_timeout = read_timeout
-        self.enable_compression = enable_compression
-        self.token_header = 'X-Api-Token'
-
     def reset_client(self) -> None:
         """Resets the API client by clearing all attributes.
         """
@@ -413,6 +391,14 @@ def delete_file(self, project_id: str,
             delete(parent_id=project_id, resource_id=file_id)
         return response
 
+    def jwt(self) -> JwtModel:
+        """Fetches OTA JWT.
+
+        :return: JWT model
+        """
+        raw_jwt = self.get_endpoint("jwt").find()
+        return JwtModel(raw_jwt)
+
     def keys(self,
              project_id: str,
              params: Optional[Dict[str, Any]] = None

lokalise/client.py

@@ -0,0 +1,12 @@
+"""
+lokalise.endpoints.jwt_endpoint
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Module containing JWT endpoint.
+"""
+from .base_endpoint import BaseEndpoint
+
+
+class JwtEndpoint(BaseEndpoint):
+    """Describes JWT endpoint.
+    """
+    PATH = "jwt-tokens/ota"