rixl 1.0.0__tar.gz

rixl-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 RIXL Inc.
+
+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.

rixl-1.0.0/PKG-INFO

@@ -0,0 +1,183 @@
+Metadata-Version: 2.4
+Name: rixl
+Version: 1.0.0
+Summary: Python client for the RIXL API.
+License-Expression: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: microsoft-kiota-bundle==1.5.0
+Dynamic: license-file
+
+# rixl-python
+
+Python client for the [RIXL](https://rixl.com) API.
+
+[![PyPI](https://img.shields.io/pypi/v/rixl.svg)](https://pypi.org/project/rixl/)
+
+## Install
+
+```bash
+pip install rixl
+```
+
+Requires Python 3.10+. `microsoft-kiota-bundle` is pulled in transitively (HTTP transport, serializers, request adapter).
+
+## Quick start
+
+```python
+import asyncio
+from kiota_abstractions.authentication.api_key_authentication_provider import (
+    ApiKeyAuthenticationProvider, KeyLocation,
+)
+from kiota_http.httpx_request_adapter import HttpxRequestAdapter
+from rixl_client import RixlClient
+
+
+async def main():
+    auth = ApiKeyAuthenticationProvider(
+        api_key="YOUR_RIXL_API_KEY",
+        parameter_name="X-API-Key",
+        key_location=KeyLocation.Header,
+    )
+    adapter = HttpxRequestAdapter(auth)
+    client = RixlClient(adapter)
+
+    image = await client.images.by_image_id("PS5IMKoFLm").get()
+    print(image.id, image.width, image.height)
+
+
+asyncio.run(main())
+```
+
+Default base URL: `https://api.rixl.com`. Override with `adapter.base_url = "..."`.
+
+## Authentication
+
+API key:
+
+```python
+from kiota_abstractions.authentication.api_key_authentication_provider import (
+    ApiKeyAuthenticationProvider, KeyLocation,
+)
+
+auth = ApiKeyAuthenticationProvider(
+    "YOUR_RIXL_API_KEY", "X-API-Key", KeyLocation.Header,
+)
+```
+
+Bearer token: implement `AccessTokenProvider`, then wrap with `BaseBearerTokenAuthenticationProvider` from `kiota_abstractions.authentication.base_bearer_token_authentication_provider`.
+
+## Feeds
+
+```python
+posts = await client.feeds.by_feed_id("FD4y3QB38S").get()
+for post in posts.data:
+    print(post.id)
+```
+
+## Images
+
+```python
+page = await client.images.get()
+image = await client.images.by_image_id("PS5IMKoFLm").get()
+await client.images.by_image_id("PS5IMKoFLm").delete()
+```
+
+Upload (init → PUT bytes → complete):
+
+```python
+import httpx
+from models.internal_images_handler.upload_init_request import UploadInitRequest
+from models.internal_images_handler.complete_request import CompleteRequest
+
+init_req = UploadInitRequest()
+init_req.name = "photo.jpg"
+init_req.format = "jpeg"
+init_res = await client.images.upload.init.post(init_req)
+
+async with httpx.AsyncClient() as c:
+    await c.put(init_res.presigned_url, content=image_bytes,
+                headers={"Content-Type": "image/jpeg"})
+
+complete_req = CompleteRequest()
+complete_req.image_id = init_res.image_id
+complete_req.attached_to_video = False
+image = await client.images.upload.complete.post(complete_req)
+```
+
+## Videos
+
+```python
+videos = await client.videos.get()
+video = await client.videos.by_video_id("VI9VXQxWXQ").get()
+tracks = await client.videos.by_video_id("VI9VXQxWXQ").subtitles.get()
+```
+
+Upload returns presigned URLs for both the video and a poster image:
+
+```python
+from models.video_upload_init_request import VideoUploadInitRequest
+from models.github_com_rixlhq_api_internal_videos_handler_upload.complete_request \
+    import CompleteRequest as VideoCompleteRequest
+
+init_req = VideoUploadInitRequest()
+init_req.file_name = "clip.mp4"
+init_req.image_format = "jpeg"
+init_res = await client.videos.upload.init.post(init_req)
+# PUT bytes to init_res.video_presigned_url and init_res.poster_presigned_url
+
+complete_req = VideoCompleteRequest()
+complete_req.video_id = init_res.video_id
+video = await client.videos.upload.complete.post(complete_req)
+```
+
+## Pagination
+
+List endpoints take `limit`, `offset`, `sort`, `order`:
+
+```python
+from kiota_abstractions.base_request_configuration import RequestConfiguration
+from rixl_sdk.images.images_request_builder import ImagesRequestBuilder
+
+limit, offset = 50, 0
+while True:
+    params = ImagesRequestBuilder.ImagesRequestBuilderGetQueryParameters(
+        limit=limit, offset=offset,
+    )
+    page = await client.images.get(
+        request_configuration=RequestConfiguration(query_parameters=params),
+    )
+    if offset + len(page.data) >= page.pagination.total:
+        break
+    offset += limit
+```
+
+## Errors
+
+```python
+from rixl_sdk.models.github_com_rixlhq_api_internal_errors.error_response import ErrorResponse
+
+try:
+    image = await client.images.by_image_id("PS5IMKoFLm").get()
+except ErrorResponse as e:
+    print(f"HTTP {e.code}: {e.error}")
+```
+
+Network failures raise `httpx` exceptions.
+
+## Examples
+
+Runnable demos in [examples/](./examples):
+
+```bash
+cd examples
+pip install -r requirements.txt
+export RIXL_API_KEY=<key>
+python basic/images/main.py
+python advanced/videos/main.py
+```
+
+## Issues
+
+[github.com/rixlhq/rixl-python/issues](https://github.com/rixlhq/rixl-python/issues)

rixl-1.0.0/README.md

@@ -0,0 +1,172 @@
+# rixl-python
+
+Python client for the [RIXL](https://rixl.com) API.
+
+[![PyPI](https://img.shields.io/pypi/v/rixl.svg)](https://pypi.org/project/rixl/)
+
+## Install
+
+```bash
+pip install rixl
+```
+
+Requires Python 3.10+. `microsoft-kiota-bundle` is pulled in transitively (HTTP transport, serializers, request adapter).
+
+## Quick start
+
+```python
+import asyncio
+from kiota_abstractions.authentication.api_key_authentication_provider import (
+    ApiKeyAuthenticationProvider, KeyLocation,
+)
+from kiota_http.httpx_request_adapter import HttpxRequestAdapter
+from rixl_client import RixlClient
+
+
+async def main():
+    auth = ApiKeyAuthenticationProvider(
+        api_key="YOUR_RIXL_API_KEY",
+        parameter_name="X-API-Key",
+        key_location=KeyLocation.Header,
+    )
+    adapter = HttpxRequestAdapter(auth)
+    client = RixlClient(adapter)
+
+    image = await client.images.by_image_id("PS5IMKoFLm").get()
+    print(image.id, image.width, image.height)
+
+
+asyncio.run(main())
+```
+
+Default base URL: `https://api.rixl.com`. Override with `adapter.base_url = "..."`.
+
+## Authentication
+
+API key:
+
+```python
+from kiota_abstractions.authentication.api_key_authentication_provider import (
+    ApiKeyAuthenticationProvider, KeyLocation,
+)
+
+auth = ApiKeyAuthenticationProvider(
+    "YOUR_RIXL_API_KEY", "X-API-Key", KeyLocation.Header,
+)
+```
+
+Bearer token: implement `AccessTokenProvider`, then wrap with `BaseBearerTokenAuthenticationProvider` from `kiota_abstractions.authentication.base_bearer_token_authentication_provider`.
+
+## Feeds
+
+```python
+posts = await client.feeds.by_feed_id("FD4y3QB38S").get()
+for post in posts.data:
+    print(post.id)
+```
+
+## Images
+
+```python
+page = await client.images.get()
+image = await client.images.by_image_id("PS5IMKoFLm").get()
+await client.images.by_image_id("PS5IMKoFLm").delete()
+```
+
+Upload (init → PUT bytes → complete):
+
+```python
+import httpx
+from models.internal_images_handler.upload_init_request import UploadInitRequest
+from models.internal_images_handler.complete_request import CompleteRequest
+
+init_req = UploadInitRequest()
+init_req.name = "photo.jpg"
+init_req.format = "jpeg"
+init_res = await client.images.upload.init.post(init_req)
+
+async with httpx.AsyncClient() as c:
+    await c.put(init_res.presigned_url, content=image_bytes,
+                headers={"Content-Type": "image/jpeg"})
+
+complete_req = CompleteRequest()
+complete_req.image_id = init_res.image_id
+complete_req.attached_to_video = False
+image = await client.images.upload.complete.post(complete_req)
+```
+
+## Videos
+
+```python
+videos = await client.videos.get()
+video = await client.videos.by_video_id("VI9VXQxWXQ").get()
+tracks = await client.videos.by_video_id("VI9VXQxWXQ").subtitles.get()
+```
+
+Upload returns presigned URLs for both the video and a poster image:
+
+```python
+from models.video_upload_init_request import VideoUploadInitRequest
+from models.github_com_rixlhq_api_internal_videos_handler_upload.complete_request \
+    import CompleteRequest as VideoCompleteRequest
+
+init_req = VideoUploadInitRequest()
+init_req.file_name = "clip.mp4"
+init_req.image_format = "jpeg"
+init_res = await client.videos.upload.init.post(init_req)
+# PUT bytes to init_res.video_presigned_url and init_res.poster_presigned_url
+
+complete_req = VideoCompleteRequest()
+complete_req.video_id = init_res.video_id
+video = await client.videos.upload.complete.post(complete_req)
+```
+
+## Pagination
+
+List endpoints take `limit`, `offset`, `sort`, `order`:
+
+```python
+from kiota_abstractions.base_request_configuration import RequestConfiguration
+from rixl_sdk.images.images_request_builder import ImagesRequestBuilder
+
+limit, offset = 50, 0
+while True:
+    params = ImagesRequestBuilder.ImagesRequestBuilderGetQueryParameters(
+        limit=limit, offset=offset,
+    )
+    page = await client.images.get(
+        request_configuration=RequestConfiguration(query_parameters=params),
+    )
+    if offset + len(page.data) >= page.pagination.total:
+        break
+    offset += limit
+```
+
+## Errors
+
+```python
+from rixl_sdk.models.github_com_rixlhq_api_internal_errors.error_response import ErrorResponse
+
+try:
+    image = await client.images.by_image_id("PS5IMKoFLm").get()
+except ErrorResponse as e:
+    print(f"HTTP {e.code}: {e.error}")
+```
+
+Network failures raise `httpx` exceptions.
+
+## Examples
+
+Runnable demos in [examples/](./examples):
+
+```bash
+cd examples
+pip install -r requirements.txt
+export RIXL_API_KEY=<key>
+python basic/images/main.py
+python advanced/videos/main.py
+```
+
+## Issues
+
+[github.com/rixlhq/rixl-python/issues](https://github.com/rixlhq/rixl-python/issues)

rixl-1.0.0/feeds/feeds_request_builder.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+from collections.abc import Callable
+from kiota_abstractions.base_request_builder import BaseRequestBuilder
+from kiota_abstractions.get_path_parameters import get_path_parameters
+from kiota_abstractions.request_adapter import RequestAdapter
+from typing import Any, Optional, TYPE_CHECKING, Union
+
+if TYPE_CHECKING:
+    from .item.with_feed_item_request_builder import WithFeedItemRequestBuilder
+
+class FeedsRequestBuilder(BaseRequestBuilder):
+    """
+    Builds and executes requests for operations under /feeds
+    """
+    def __init__(self,request_adapter: RequestAdapter, path_parameters: Union[str, dict[str, Any]]) -> None:
+        """
+        Instantiates a new FeedsRequestBuilder and sets the default values.
+        param path_parameters: The raw url or the url-template parameters for the request.
+        param request_adapter: The request adapter to use to execute the requests.
+        Returns: None
+        """
+        super().__init__(request_adapter, "{+baseurl}/feeds", path_parameters)
+    
+    def by_feed_id(self,feed_id: str) -> WithFeedItemRequestBuilder:
+        """
+        Gets an item from the rixl_sdk.feeds.item collection
+        param feed_id: Feed ID
+        Returns: WithFeedItemRequestBuilder
+        """
+        if feed_id is None:
+            raise TypeError("feed_id cannot be null.")
+        from .item.with_feed_item_request_builder import WithFeedItemRequestBuilder
+
+        url_tpl_params = get_path_parameters(self.path_parameters)
+        url_tpl_params["feedId"] = feed_id
+        return WithFeedItemRequestBuilder(self.request_adapter, url_tpl_params)
+    
+

rixl-1.0.0/feeds/item/creators/creators_request_builder.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+from collections.abc import Callable
+from kiota_abstractions.base_request_builder import BaseRequestBuilder
+from kiota_abstractions.get_path_parameters import get_path_parameters
+from kiota_abstractions.request_adapter import RequestAdapter
+from typing import Any, Optional, TYPE_CHECKING, Union
+
+if TYPE_CHECKING:
+    from .item.with_creator_item_request_builder import WithCreatorItemRequestBuilder
+
+class CreatorsRequestBuilder(BaseRequestBuilder):
+    """
+    Builds and executes requests for operations under /feeds/{feedId}/creators
+    """
+    def __init__(self,request_adapter: RequestAdapter, path_parameters: Union[str, dict[str, Any]]) -> None:
+        """
+        Instantiates a new CreatorsRequestBuilder and sets the default values.
+        param path_parameters: The raw url or the url-template parameters for the request.
+        param request_adapter: The request adapter to use to execute the requests.
+        Returns: None
+        """
+        super().__init__(request_adapter, "{+baseurl}/feeds/{feedId}/creators", path_parameters)
+    
+    def by_creator_id(self,creator_id: str) -> WithCreatorItemRequestBuilder:
+        """
+        Gets an item from the rixl_sdk.feeds.item.creators.item collection
+        param creator_id: Creator ID
+        Returns: WithCreatorItemRequestBuilder
+        """
+        if creator_id is None:
+            raise TypeError("creator_id cannot be null.")
+        from .item.with_creator_item_request_builder import WithCreatorItemRequestBuilder
+
+        url_tpl_params = get_path_parameters(self.path_parameters)
+        url_tpl_params["creatorId"] = creator_id
+        return WithCreatorItemRequestBuilder(self.request_adapter, url_tpl_params)
+    
+

rixl-1.0.0/feeds/item/creators/item/with_creator_item_request_builder.py

@@ -0,0 +1,94 @@
+from __future__ import annotations
+from collections.abc import Callable
+from dataclasses import dataclass, field
+from kiota_abstractions.base_request_builder import BaseRequestBuilder
+from kiota_abstractions.base_request_configuration import RequestConfiguration
+from kiota_abstractions.default_query_parameters import QueryParameters
+from kiota_abstractions.get_path_parameters import get_path_parameters
+from kiota_abstractions.method import Method
+from kiota_abstractions.request_adapter import RequestAdapter
+from kiota_abstractions.request_information import RequestInformation
+from kiota_abstractions.request_option import RequestOption
+from kiota_abstractions.serialization import Parsable, ParsableFactory
+from typing import Any, Optional, TYPE_CHECKING, Union
+from warnings import warn
+
+if TYPE_CHECKING:
+    from .....models.github_com_rixlhq_api_internal_errors.error_response import ErrorResponse
+    from .....models.pagination.paginated_response_post import PaginatedResponsePost
+
+class WithCreatorItemRequestBuilder(BaseRequestBuilder):
+    """
+    Builds and executes requests for operations under /feeds/{feedId}/creators/{creatorId}
+    """
+    def __init__(self,request_adapter: RequestAdapter, path_parameters: Union[str, dict[str, Any]]) -> None:
+        """
+        Instantiates a new WithCreatorItemRequestBuilder and sets the default values.
+        param path_parameters: The raw url or the url-template parameters for the request.
+        param request_adapter: The request adapter to use to execute the requests.
+        Returns: None
+        """
+        super().__init__(request_adapter, "{+baseurl}/feeds/{feedId}/creators/{creatorId}{?limit*,offset*}", path_parameters)
+    
+    async def get(self,request_configuration: Optional[RequestConfiguration[WithCreatorItemRequestBuilderGetQueryParameters]] = None) -> Optional[PaginatedResponsePost]:
+        """
+        Retrieve posts in a feed by a specific creator, with pagination.
+        param request_configuration: Configuration for the request such as headers, query parameters, and middleware options.
+        Returns: Optional[PaginatedResponsePost]
+        """
+        request_info = self.to_get_request_information(
+            request_configuration
+        )
+        from .....models.github_com_rixlhq_api_internal_errors.error_response import ErrorResponse
+
+        error_mapping: dict[str, type[ParsableFactory]] = {
+            "400": ErrorResponse,
+            "500": ErrorResponse,
+        }
+        if not self.request_adapter:
+            raise Exception("Http core is null") 
+        from .....models.pagination.paginated_response_post import PaginatedResponsePost
+
+        return await self.request_adapter.send_async(request_info, PaginatedResponsePost, error_mapping)
+    
+    def to_get_request_information(self,request_configuration: Optional[RequestConfiguration[WithCreatorItemRequestBuilderGetQueryParameters]] = None) -> RequestInformation:
+        """
+        Retrieve posts in a feed by a specific creator, with pagination.
+        param request_configuration: Configuration for the request such as headers, query parameters, and middleware options.
+        Returns: RequestInformation
+        """
+        request_info = RequestInformation(Method.GET, self.url_template, self.path_parameters)
+        request_info.configure(request_configuration)
+        request_info.headers.try_add("Accept", "application/json")
+        return request_info
+    
+    def with_url(self,raw_url: str) -> WithCreatorItemRequestBuilder:
+        """
+        Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.
+        param raw_url: The raw URL to use for the request builder.
+        Returns: WithCreatorItemRequestBuilder
+        """
+        if raw_url is None:
+            raise TypeError("raw_url cannot be null.")
+        return WithCreatorItemRequestBuilder(self.request_adapter, raw_url)
+    
+    @dataclass
+    class WithCreatorItemRequestBuilderGetQueryParameters():
+        """
+        Retrieve posts in a feed by a specific creator, with pagination.
+        """
+        # Maximum number of items to return in a single request. <br> **Default:** `25`
+        limit: Optional[int] = None
+
+        # Starting point of the result set. <br>To get page 2 with a limit of 25, set `offset` to `25`. <br> **Default:** `0`
+        offset: Optional[int] = None
+
+    
+    @dataclass
+    class WithCreatorItemRequestBuilderGetRequestConfiguration(RequestConfiguration[WithCreatorItemRequestBuilderGetQueryParameters]):
+        """
+        Configuration for the request such as headers, query parameters, and middleware options.
+        """
+        warn("This class is deprecated. Please use the generic RequestConfiguration class generated by the generator.", DeprecationWarning)
+    
+

rixl-1.0.0/feeds/item/item/with_post_item_request_builder.py

@@ -0,0 +1,82 @@
+from __future__ import annotations
+from collections.abc import Callable
+from dataclasses import dataclass, field
+from kiota_abstractions.base_request_builder import BaseRequestBuilder
+from kiota_abstractions.base_request_configuration import RequestConfiguration
+from kiota_abstractions.default_query_parameters import QueryParameters
+from kiota_abstractions.get_path_parameters import get_path_parameters
+from kiota_abstractions.method import Method
+from kiota_abstractions.request_adapter import RequestAdapter
+from kiota_abstractions.request_information import RequestInformation
+from kiota_abstractions.request_option import RequestOption
+from kiota_abstractions.serialization import Parsable, ParsableFactory
+from typing import Any, Optional, TYPE_CHECKING, Union
+from warnings import warn
+
+if TYPE_CHECKING:
+    from ....models.github_com_rixlhq_api_internal_errors.error_response import ErrorResponse
+    from ....models.post import Post
+
+class WithPostItemRequestBuilder(BaseRequestBuilder):
+    """
+    Builds and executes requests for operations under /feeds/{feedId}/{postId}
+    """
+    def __init__(self,request_adapter: RequestAdapter, path_parameters: Union[str, dict[str, Any]]) -> None:
+        """
+        Instantiates a new WithPostItemRequestBuilder and sets the default values.
+        param path_parameters: The raw url or the url-template parameters for the request.
+        param request_adapter: The request adapter to use to execute the requests.
+        Returns: None
+        """
+        super().__init__(request_adapter, "{+baseurl}/feeds/{feedId}/{postId}", path_parameters)
+    
+    async def get(self,request_configuration: Optional[RequestConfiguration[QueryParameters]] = None) -> Optional[Post]:
+        """
+        Retrieve a post from feed by its ID
+        param request_configuration: Configuration for the request such as headers, query parameters, and middleware options.
+        Returns: Optional[Post]
+        """
+        request_info = self.to_get_request_information(
+            request_configuration
+        )
+        from ....models.github_com_rixlhq_api_internal_errors.error_response import ErrorResponse
+
+        error_mapping: dict[str, type[ParsableFactory]] = {
+            "400": ErrorResponse,
+            "404": ErrorResponse,
+        }
+        if not self.request_adapter:
+            raise Exception("Http core is null") 
+        from ....models.post import Post
+
+        return await self.request_adapter.send_async(request_info, Post, error_mapping)
+    
+    def to_get_request_information(self,request_configuration: Optional[RequestConfiguration[QueryParameters]] = None) -> RequestInformation:
+        """
+        Retrieve a post from feed by its ID
+        param request_configuration: Configuration for the request such as headers, query parameters, and middleware options.
+        Returns: RequestInformation
+        """
+        request_info = RequestInformation(Method.GET, self.url_template, self.path_parameters)
+        request_info.configure(request_configuration)
+        request_info.headers.try_add("Accept", "application/json")
+        return request_info
+    
+    def with_url(self,raw_url: str) -> WithPostItemRequestBuilder:
+        """
+        Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.
+        param raw_url: The raw URL to use for the request builder.
+        Returns: WithPostItemRequestBuilder
+        """
+        if raw_url is None:
+            raise TypeError("raw_url cannot be null.")
+        return WithPostItemRequestBuilder(self.request_adapter, raw_url)
+    
+    @dataclass
+    class WithPostItemRequestBuilderGetRequestConfiguration(RequestConfiguration[QueryParameters]):
+        """
+        Configuration for the request such as headers, query parameters, and middleware options.
+        """
+        warn("This class is deprecated. Please use the generic RequestConfiguration class generated by the generator.", DeprecationWarning)
+    
+