Merge pull request #170 from lokalise/types

Update typing info

Author: bodrovis

.github/CONTRIBUTING.md

@@ -5,8 +5,8 @@
 3. Install the necessary dependencies using `uv sync` (please note that you'll also require [uv](https://github.com/astral-sh/uv) installed).  
 4. Implement your feature or bug fix.  
 5. Don't forget to add tests and make sure they pass by running `uv run pytest`. Tests will be linted automatically.  
-6. Make sure your code complies with the style guide by running `uv run pylint lokalise/`. You can also auto-fix formatting issues with: `uv run autopep8 -i -r lokalise/ -a`
-7. We use type hinting so check if everything is okay by running `uv run mypy lokalise/`.
+6. Make sure your code complies with the style guide by running `uv run ruff check`. You can also auto-fix issues with: `uv run ruff check --fix` and `uv run black .`.
+7. We use type hinting so check if everything is okay by running `uv run pyright`.
 8. If necessary, add documentation for your feature or bug fix.
 9. Commit and push your changes.
 10. [Submit a pull request.][pr]

.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
     steps:
       - uses: actions/checkout@v5
       - uses: actions/setup-python@v6

.gitignore

@@ -22,3 +22,4 @@ docs/_build
 .mypy_cache
 coverage.lcov
 .idea/
+.ruff_cache/

README.md

@@ -10,7 +10,7 @@ Official Python 3 interface for the [Lokalise APIv2](https://developers.lokalise
 
 ## Quick start
 
-This plugin requires Python 3.9 and above. Install it:
+This plugin requires Python 3.10 and above. Install it:
 
 ```
 pip install python-lokalise-api
@@ -20,7 +20,9 @@ Obtain a Lokalise API token (in your *Personal profile*) and use it:
 
 ```python
 import lokalise
+
 client = lokalise.Client('YOUR_API_TOKEN')
+
 project = client.project('123.abc')
 print(project.name)
 

docs/additional_info/changelog.rst

@@ -3,6 +3,14 @@
 Changelog
 =========
 
+4.0.0 (28-Sep-2025)
+-------------------
+
+* Require Python 3.10+
+* Fully rework typing system
+* Make code more solid, enhance error handling
+* Switch to uv, black, ruff
+
 3.5.1 (14-May-2025)
 -------------------
 

docs/additional_info/exception_handling.rst

@@ -30,7 +30,7 @@ To handle an exception you would do the following:
       client.project('invalid_id')
   except lokalise.errors.NotFound as err:
       print(err.message)
-      print(err.code)
+      print(err.status_code)
 
 Rate limits
 -----------

docs/api/getting_started.rst

@@ -6,7 +6,7 @@ Getting started
 Installation and requirements
 -----------------------------
 
-This plugin requires `Python 3.9 <http://www.python.org/>`_ or above and `PIP <https://pypi.org/project/pip/>`_.
+This plugin requires `Python 3.10 <http://www.python.org/>`_ or above and `PIP <https://pypi.org/project/pip/>`_.
 
 Install it by running:
 

docs/conf.py

@@ -12,60 +12,60 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+
+sys.path.insert(0, os.path.abspath(".."))
 from lokalise._version import __version__
 
 # -- Project information -----------------------------------------------------
-project = 'python-lokalise-api'
-copyright = '2023, Lokalise group, Ilya Krukowski'
-author = 'Lokalise group, Ilya Krukowski'
+project = "python-lokalise-api"
+copyright = "2023, Lokalise group, Ilya Krukowski"
+author = "Lokalise group, Ilya Krukowski"
 
 # The full version, including alpha/beta/rc tags
 release = __version__
 version = __version__
 
 # -- General configuration ---------------------------------------------------
-master_doc = 'index'
+master_doc = "index"
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
-]
+extensions = []
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
-html_title = 'Python Lokalise API client'
-html_short_title = 'Lokalise API client'
+html_title = "Python Lokalise API client"
+html_short_title = "Lokalise API client"
 
 html_sidebars = {
     "index": [
-        'about.html',
+        "about.html",
         "globaltoc.html",
         "links.html",
         "slim_searchbox.html",
     ],
     "**": [
-        'about.html',
+        "about.html",
         "globaltoc.html",
         "relations.html",
         "links.html",
@@ -74,9 +74,9 @@
 }
 
 html_theme_options = {
-    'logo': 'lok_logo.png',
-    'github_user': 'lokalise',
-    'github_repo': 'python-lokalise-api',
-    'github_button': 'true',
-    'show_powered_by': 'false'
+    "logo": "lok_logo.png",
+    "github_user": "lokalise",
+    "github_repo": "python-lokalise-api",
+    "github_button": "true",
+    "show_powered_by": "false",
 }

lokalise/__init__.py

@@ -6,6 +6,9 @@
 :license: BSD 3 Clause License, see LICENSE for more details.
 """
 
+from . import errors as errors
 from .client import Client
-from .oauth_client import OAuthClient
 from .oauth2.auth import Auth
+from .oauth_client import OAuthClient
+
+__all__ = ["Client", "Auth", "OAuthClient", "errors"]

lokalise/_version.py

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