Merge pull request #51 from uhlikfil/main

feat: export public interface in root package
rossumai · Oct 11, 2023 · 977824f · 977824f
2 parents 44b049c + f85fc58
commit 977824f
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -48,7 +48,7 @@ Async version:
 
 ```python
 import asyncio
-from rossum_api.elis_api_client import ElisAPIClient
+from rossum_api import ElisAPIClient
 
 WORKSPACE = {
     "name": "Rossum Client NG Test",
@@ -77,7 +77,7 @@ asyncio.run(main_with_async_client())
 Sync version:
 
 ```python
-from rossum_api.elis_api_client_sync import ElisAPIClientSync
+from rossum_api import ElisAPIClientSync
 
 WORKSPACE = {
     "name": "Rossum Client NG Test",

diff --git a/rossum_api/__init__.py b/rossum_api/__init__.py
@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from rossum_api.api_client import APIClientError
+from rossum_api.elis_api_client import ElisAPIClient, ExportFileFormats
+from rossum_api.elis_api_client_sync import ElisAPIClientSync
+
+__all__ = (
+    "APIClientError",
+    "ElisAPIClient",
+    "ElisAPIClientSync",
+    "ExportFileFormats",
+)
diff --git a/rossum_api/elis_api_client_sync.py b/rossum_api/elis_api_client_sync.py
@@ -3,7 +3,7 @@
 import asyncio
 import typing
 
-from rossum_api.elis_api_client import ElisAPIClient
+from rossum_api import ElisAPIClient
 
 if typing.TYPE_CHECKING:
     import pathlib
@@ -23,8 +23,8 @@
 
     import httpx
 
+    from rossum_api import ExportFileFormats
     from rossum_api.api_client import APIClient
-    from rossum_api.elis_api_client import ExportFileFormats
     from rossum_api.models.annotation import Annotation
     from rossum_api.models.connector import Connector
     from rossum_api.models.hook import Hook

diff --git a/test.py b/test.py
@@ -11,9 +11,8 @@
 
 import aiofiles
 
+from rossum_api import ElisAPIClient, ElisAPIClientSync
 from rossum_api.api_client import APIClient
-from rossum_api.elis_api_client import ElisAPIClient
-from rossum_api.elis_api_client_sync import ElisAPIClientSync
 
 logging.basicConfig()
 logging.getLogger().setLevel(logging.DEBUG)

diff --git a/tests/conftest.py b/tests/conftest.py
@@ -5,9 +5,8 @@
 import pytest_asyncio
 from mock import MagicMock
 
+from rossum_api import ElisAPIClient, ElisAPIClientSync
 from rossum_api.api_client import APIClient
-from rossum_api.elis_api_client import ElisAPIClient
-from rossum_api.elis_api_client_sync import ElisAPIClientSync
 
 
 @pytest.fixture

diff --git a/tests/e2e.py b/tests/e2e.py
@@ -8,7 +8,7 @@
 import pytest
 from aiofiles import os as aios
 
-from rossum_api.elis_api_client import ElisAPIClient
+from rossum_api import ElisAPIClient
 
 if TYPE_CHECKING:
     from typing import Optional

diff --git a/tests/elis_api_client/test_client_sync.py b/tests/elis_api_client/test_client_sync.py
@@ -5,7 +5,8 @@
 from mock import patch
 from mock.mock import MagicMock
 
-from rossum_api.elis_api_client_sync import AsyncRuntimeError, ElisAPIClientSync
+from rossum_api import ElisAPIClientSync
+from rossum_api.elis_api_client_sync import AsyncRuntimeError
 
 
 class TestClientSync: