flipt 1.3.0__py3-none-any.whl

flipt/__init__.py

@@ -0,0 +1,7 @@
+from .async_client import AsyncFliptClient
+from .sync_client import FliptClient
+
+__all__ = [
+    "FliptClient",
+    "AsyncFliptClient",
+]

flipt/async_client.py

@@ -0,0 +1,21 @@
+import httpx
+
+from .authentication import AuthenticationStrategy
+from .evaluation import AsyncEvaluation
+from .flags import AsyncFlag
+
+
+class AsyncFliptClient:
+    def __init__(
+        self,
+        url: str = "http://localhost:8080",
+        timeout: int = 60,
+        authentication: AuthenticationStrategy | None = None,
+    ):
+        self.httpx_client = httpx.AsyncClient(timeout=timeout)
+
+        self.evaluation = AsyncEvaluation(url, authentication, self.httpx_client)
+        self.flag = AsyncFlag(url, authentication, self.httpx_client)
+
+    async def close(self) -> None:
+        await self.httpx_client.aclose()

flipt/authentication/__init__.py

@@ -0,0 +1,19 @@
+class AuthenticationStrategy:
+    def authenticate(self, headers: dict[str, str]) -> None:
+        raise NotImplementedError
+
+
+class ClientTokenAuthentication(AuthenticationStrategy):
+    def __init__(self, token: str) -> None:
+        self.token = token
+
+    def authenticate(self, headers: dict[str, str]) -> None:
+        headers["Authorization"] = f"Bearer {self.token}"
+
+
+class JWTAuthentication(AuthenticationStrategy):
+    def __init__(self, token: str) -> None:
+        self.token = token
+
+    def authenticate(self, headers: dict[str, str]) -> None:
+        headers["Authorization"] = f"JWT {self.token}"

flipt/evaluation/__init__.py

@@ -0,0 +1,29 @@
+from .async_evaluation_client import AsyncEvaluation
+from .models import (
+    BatchEvaluationRequest,
+    BatchEvaluationResponse,
+    BooleanEvaluationResponse,
+    ErrorEvaluationReason,
+    ErrorEvaluationResponse,
+    EvaluationReason,
+    EvaluationRequest,
+    EvaluationResponse,
+    EvaluationResponseType,
+    VariantEvaluationResponse,
+)
+from .sync_evaluation_client import Evaluation
+
+__all__ = [
+    "Evaluation",
+    "AsyncEvaluation",
+    "EvaluationResponseType",
+    "EvaluationReason",
+    "ErrorEvaluationReason",
+    "EvaluationRequest",
+    "BatchEvaluationRequest",
+    "VariantEvaluationResponse",
+    "BooleanEvaluationResponse",
+    "ErrorEvaluationResponse",
+    "EvaluationResponse",
+    "BatchEvaluationResponse",
+]

flipt/evaluation/async_evaluation_client.py

@@ -0,0 +1,69 @@
+from http import HTTPStatus
+
+import httpx
+
+from flipt.authentication import AuthenticationStrategy
+from flipt.exceptions import FliptApiError
+
+from .models import (
+    BatchEvaluationRequest,
+    BatchEvaluationResponse,
+    BooleanEvaluationResponse,
+    EvaluationRequest,
+    VariantEvaluationResponse,
+)
+
+
+class AsyncEvaluation:
+    def __init__(
+        self,
+        url: str,
+        authentication: AuthenticationStrategy | None = None,
+        httpx_client: httpx.AsyncClient | None = None,
+    ):
+        self.url = url
+        self.headers: dict[str, str] = {}
+
+        self._client = httpx_client or httpx.AsyncClient()
+
+        if authentication:
+            authentication.authenticate(self.headers)
+
+    async def close(self) -> None:
+        await self._client.aclose()
+
+    def _raise_on_error(self, response: httpx.Response) -> None:
+        if response.status_code != 200:
+            body = response.json()
+            message = body.get("message", HTTPStatus(response.status_code).description)
+            raise FliptApiError(message, response.status_code)
+
+    async def variant(self, request: EvaluationRequest) -> VariantEvaluationResponse:
+        response = await self._client.post(
+            f"{self.url}/evaluate/v1/variant",
+            headers=self.headers,
+            json=request.model_dump(),
+        )
+
+        self._raise_on_error(response)
+        return VariantEvaluationResponse.model_validate_json(response.text)
+
+    async def boolean(self, request: EvaluationRequest) -> BooleanEvaluationResponse:
+        response = await self._client.post(
+            f"{self.url}/evaluate/v1/boolean",
+            headers=self.headers,
+            json=request.model_dump(),
+        )
+
+        self._raise_on_error(response)
+        return BooleanEvaluationResponse.model_validate_json(response.text)
+
+    async def batch(self, request: BatchEvaluationRequest) -> BatchEvaluationResponse:
+        response = await self._client.post(
+            f"{self.url}/evaluate/v1/batch",
+            headers=self.headers,
+            json=request.model_dump(),
+        )
+
+        self._raise_on_error(response)
+        return BatchEvaluationResponse.model_validate_json(response.text)

flipt/evaluation/models.py

@@ -0,0 +1,75 @@
+from enum import StrEnum
+
+from pydantic import Field
+
+from flipt.models import CamelAliasModel
+
+
+class EvaluationResponseType(StrEnum):
+    VARIANT_EVALUATION_RESPONSE_TYPE = "VARIANT_EVALUATION_RESPONSE_TYPE"
+    BOOLEAN_EVALUATION_RESPONSE_TYPE = "BOOLEAN_EVALUATION_RESPONSE_TYPE"
+    ERROR_EVALUATION_RESPONSE_TYPE = "ERROR_EVALUATION_RESPONSE_TYPE"
+
+
+class EvaluationReason(StrEnum):
+    UNKNOWN_EVALUATION_REASON = "UNKNOWN_EVALUATION_REASON"
+    FLAG_DISABLED_EVALUATION_REASON = "FLAG_DISABLED_EVALUATION_REASON"
+    MATCH_EVALUATION_REASON = "MATCH_EVALUATION_REASON"
+    DEFAULT_EVALUATION_REASON = "DEFAULT_EVALUATION_REASON"
+
+
+class ErrorEvaluationReason(StrEnum):
+    UNKNOWN_ERROR_EVALUATION_REASON = "UNKNOWN_ERROR_EVALUATION_REASON"
+    NOT_FOUND_ERROR_EVALUATION_REASON = "NOT_FOUND_ERROR_EVALUATION_REASON"
+
+
+class EvaluationRequest(CamelAliasModel):
+    namespace_key: str = Field(default="default")
+    flag_key: str
+    entity_id: str
+    context: dict
+    reference: str | None = None
+
+
+class BatchEvaluationRequest(CamelAliasModel):
+    request_id: str | None = None
+    requests: list[EvaluationRequest]
+    reference: str | None = None
+
+
+class VariantEvaluationResponse(CamelAliasModel):
+    match: bool
+    segment_keys: list[str]
+    reason: EvaluationReason
+    flag_key: str
+    variant_key: str
+    variant_attachment: str
+    request_duration_millis: float
+    timestamp: str
+
+
+class BooleanEvaluationResponse(CamelAliasModel):
+    enabled: bool
+    flag_key: str
+    reason: EvaluationReason
+    request_duration_millis: float
+    timestamp: str
+
+
+class ErrorEvaluationResponse(CamelAliasModel):
+    flag_key: str
+    namespace_key: str
+    reason: ErrorEvaluationReason
+
+
+class EvaluationResponse(CamelAliasModel):
+    type: EvaluationResponseType
+    boolean_response: BooleanEvaluationResponse | None = None
+    variant_response: VariantEvaluationResponse | None = None
+    error_response: ErrorEvaluationResponse | None = None
+
+
+class BatchEvaluationResponse(CamelAliasModel):
+    request_id: str
+    responses: list[EvaluationResponse]
+    request_duration_millis: float

flipt/evaluation/sync_evaluation_client.py

@@ -0,0 +1,69 @@
+from http import HTTPStatus
+
+import httpx
+
+from flipt.authentication import AuthenticationStrategy
+from flipt.exceptions import FliptApiError
+
+from .models import (
+    BatchEvaluationRequest,
+    BatchEvaluationResponse,
+    BooleanEvaluationResponse,
+    EvaluationRequest,
+    VariantEvaluationResponse,
+)
+
+
+class Evaluation:
+    def __init__(
+        self,
+        url: str,
+        authentication: AuthenticationStrategy | None = None,
+        httpx_client: httpx.Client | None = None,
+    ):
+        self.url = url
+        self.headers: dict[str, str] = {}
+
+        self._client = httpx_client or httpx.Client()
+
+        if authentication:
+            authentication.authenticate(self.headers)
+
+    def close(self) -> None:
+        self._client.close()
+
+    def _raise_on_error(self, response: httpx.Response) -> None:
+        if response.status_code != 200:
+            body = response.json()
+            message = body.get("message", HTTPStatus(response.status_code).description)
+            raise FliptApiError(message, response.status_code)
+
+    def variant(self, request: EvaluationRequest) -> VariantEvaluationResponse:
+        response = self._client.post(
+            f"{self.url}/evaluate/v1/variant",
+            headers=self.headers,
+            json=request.model_dump(),
+        )
+
+        self._raise_on_error(response)
+        return VariantEvaluationResponse.model_validate_json(response.text)
+
+    def boolean(self, request: EvaluationRequest) -> BooleanEvaluationResponse:
+        response = self._client.post(
+            f"{self.url}/evaluate/v1/boolean",
+            headers=self.headers,
+            json=request.model_dump(),
+        )
+
+        self._raise_on_error(response)
+        return BooleanEvaluationResponse.model_validate_json(response.text)
+
+    def batch(self, request: BatchEvaluationRequest) -> BatchEvaluationResponse:
+        response = self._client.post(
+            f"{self.url}/evaluate/v1/batch",
+            headers=self.headers,
+            json=request.model_dump(),
+        )
+
+        self._raise_on_error(response)
+        return BatchEvaluationResponse.model_validate_json(response.text)

flipt/exceptions.py

@@ -0,0 +1,14 @@
+class BaseFliptError(Exception):
+    pass
+
+
+class FliptApiError(BaseFliptError):
+    message: str
+    status_code: int
+
+    def __init__(self, message: str, status_code: int):
+        self.message = message
+        self.status_code = status_code
+
+    def __repr__(self) -> str:
+        return f"<FliptApiError(message={self.message}, status_code={self.status_code})>"

flipt/flags/__init__.py

@@ -0,0 +1,15 @@
+from .async_flag_client import AsyncFlag
+from .models import (
+    Flag,
+    FlagType,
+    ListFlagsResponse,
+)
+from .sync_flag_client import SyncFlag
+
+__all__ = [
+    "AsyncFlag",
+    "SyncFlag",
+    "ListFlagsResponse",
+    "Flag",
+    "FlagType",
+]

flipt/flags/async_flag_client.py

@@ -0,0 +1,52 @@
+from http import HTTPStatus
+
+import httpx
+
+from flipt.authentication import AuthenticationStrategy
+from flipt.exceptions import FliptApiError
+from flipt.models import CommonParameters, ListParameters
+
+from .models import Flag, ListFlagsResponse
+
+
+class AsyncFlag:
+    def __init__(
+        self,
+        url: str,
+        authentication: AuthenticationStrategy | None = None,
+        httpx_client: httpx.AsyncClient | None = None,
+    ):
+        self.url = url
+        self.headers: dict[str, str] = {}
+
+        self._client = httpx_client or httpx.AsyncClient()
+
+        if authentication:
+            authentication.authenticate(self.headers)
+
+    async def close(self) -> None:
+        await self._client.aclose()
+
+    def _raise_on_error(self, response: httpx.Response) -> None:
+        if response.status_code != 200:
+            body = response.json()
+            message = body.get("message", HTTPStatus(response.status_code).description)
+            raise FliptApiError(message, response.status_code)
+
+    async def list_flags(self, namespace_key: str, params: ListParameters | None = None) -> ListFlagsResponse:
+        response = await self._client.get(
+            f"{self.url}/api/v1/namespaces/{namespace_key}/flags",
+            params=params.model_dump_json(exclude_none=True, by_alias=True) if params else {},
+            headers=self.headers,
+        )
+        self._raise_on_error(response)
+        return ListFlagsResponse.model_validate_json(response.text)
+
+    async def get_flag(self, namespace_key: str, flag_key: str, params: CommonParameters | None = None) -> Flag:
+        response = await self._client.get(
+            f"{self.url}/api/v1/namespaces/{namespace_key}/flags/{flag_key}",
+            params=params.model_dump_json(exclude_none=True, by_alias=True) if params else {},
+            headers=self.headers,
+        )
+        self._raise_on_error(response)
+        return Flag.model_validate_json(response.text)

flipt/flags/models.py

@@ -0,0 +1,37 @@
+from datetime import datetime
+from enum import StrEnum
+
+from flipt.models import CamelAliasModel, PaginatedResponse
+
+
+class FlagType(StrEnum):
+    variant = "VARIANT_FLAG_TYPE"
+    boolean = "BOOLEAN_FLAG_TYPE"
+
+
+class Variant(CamelAliasModel):
+    attachment: str
+    description: str
+    flag_key: str
+    id: str
+    key: str
+    name: str
+    namespace_key: str
+    created_at: datetime
+    updated_at: datetime
+
+
+class Flag(CamelAliasModel):
+    key: str
+    name: str
+    description: str
+    enabled: bool
+    namespace_key: str
+    type: FlagType
+    created_at: datetime
+    updated_at: datetime
+    variants: list[Variant]
+
+
+class ListFlagsResponse(PaginatedResponse):
+    flags: list[Flag]

flipt/flags/sync_flag_client.py

@@ -0,0 +1,52 @@
+from http import HTTPStatus
+
+import httpx
+
+from flipt.authentication import AuthenticationStrategy
+from flipt.exceptions import FliptApiError
+from flipt.models import CommonParameters, ListParameters
+
+from .models import Flag, ListFlagsResponse
+
+
+class SyncFlag:
+    def __init__(
+        self,
+        url: str,
+        authentication: AuthenticationStrategy | None = None,
+        httpx_client: httpx.Client | None = None,
+    ):
+        self.url = url
+        self.headers: dict[str, str] = {}
+
+        self._client = httpx_client or httpx.Client()
+
+        if authentication:
+            authentication.authenticate(self.headers)
+
+    def close(self) -> None:
+        self._client.close()
+
+    def _raise_on_error(self, response: httpx.Response) -> None:
+        if response.status_code != 200:
+            body = response.json()
+            message = body.get("message", HTTPStatus(response.status_code).description)
+            raise FliptApiError(message, response.status_code)
+
+    def list_flags(self, namespace_key: str, params: ListParameters | None = None) -> ListFlagsResponse:
+        response = self._client.get(
+            f"{self.url}/api/v1/namespaces/{namespace_key}/flags",
+            params=params.model_dump_json(exclude_none=True, by_alias=True) if params else {},
+            headers=self.headers,
+        )
+        self._raise_on_error(response)
+        return ListFlagsResponse.model_validate_json(response.text)
+
+    def get_flag(self, namespace_key: str, flag_key: str, params: CommonParameters | None = None) -> Flag:
+        response = self._client.get(
+            f"{self.url}/api/v1/namespaces/{namespace_key}/flags/{flag_key}",
+            params=params.model_dump_json(exclude_none=True, by_alias=True) if params else {},
+            headers=self.headers,
+        )
+        self._raise_on_error(response)
+        return Flag.model_validate_json(response.text)

flipt/models.py

@@ -0,0 +1,24 @@
+from pydantic import AliasGenerator, BaseModel, ConfigDict
+from pydantic.alias_generators import to_camel
+
+
+class CamelAliasModel(BaseModel):
+    model_config = ConfigDict(
+        alias_generator=AliasGenerator(alias=to_camel),
+        populate_by_name=True,
+    )
+
+
+class CommonParameters(CamelAliasModel):
+    reference: str | None = None
+
+
+class ListParameters(CommonParameters):
+    limit: int | None = None
+    offset: int | None = None
+    page_token: str | None = None
+
+
+class PaginatedResponse(CamelAliasModel):
+    next_page_token: str
+    total_count: int

flipt/sync_client.py

@@ -0,0 +1,21 @@
+import httpx
+
+from .authentication import AuthenticationStrategy
+from .evaluation import Evaluation
+from .flags import SyncFlag
+
+
+class FliptClient:
+    def __init__(
+        self,
+        url: str = "http://localhost:8080",
+        timeout: int = 60,
+        authentication: AuthenticationStrategy | None = None,
+    ):
+        self.httpx_client = httpx.Client(timeout=timeout)
+
+        self.evaluation = Evaluation(url, authentication, self.httpx_client)
+        self.flag = SyncFlag(url, authentication, self.httpx_client)
+
+    def close(self) -> None:
+        self.httpx_client.close()

flipt-1.3.0.dist-info/METADATA

@@ -0,0 +1,64 @@
+Metadata-Version: 2.1
+Name: flipt
+Version: 1.3.0
+Summary: Flipt Server SDK
+License: MIT
+Author: Flipt Devs
+Author-email: dev@flipt.io
+Requires-Python: >=3.11,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: httpx (>=0.27.0,<0.28.0)
+Requires-Dist: pydantic (>=2.5.3,<3.0.0)
+Description-Content-Type: text/markdown
+
+# Flipt Python
+
+[![pypi](https://img.shields.io/pypi/v/flipt.svg)](https://pypi.org/project/flipt)
+
+This directory contains the Python source code for the Flipt [server-side](https://www.flipt.io/docs/integration/server/rest) client.
+
+## Documentation
+
+API documentation is available at <https://www.flipt.io/docs/reference/overview>.
+
+## Installation
+
+```sh
+pip install flipt=={version}
+```
+
+## Usage
+
+In your Python code you can import this client and use it as so:
+
+```python
+from flipt import FliptClient
+from flipt.evaluation import BatchEvaluationRequest, EvaluationRequest
+
+flipt_client = FliptClient()
+
+variant_flag = flipt_client.evaluation.variant(
+    EvaluationRequest(
+        namespace_key="default",
+        flag_key="flagll",
+        entity_id="entity",
+        context={"fizz": "buzz"},
+    )
+)
+
+print(variant_flag)
+```
+
+There is a more detailed example in the [examples](./examples) directory.
+
+
+## For developers
+
+After adding new code, please don't forget to add unit tests for new features.
+To format the code, check it with linters and run tests, use the `make check` command. 
+
+Please keep the Python [PEP8](https://peps.python.org/pep-0008/) in mind while adding new code.
+

flipt-1.3.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+flipt/__init__.py,sha256=lejYXHyiOU4aFbw2Hu7h2QytrxlGyWjofbUZAKBx9Mw,138
+flipt/async_client.py,sha256=9Du6gIOM1gV2ojZ_wocMVD9KGY6E5stLdTq-Wzv2jws,625
+flipt/authentication/__init__.py,sha256=_DOHmgWYQVLxtJ91kiQ8m-C6z7wuKyqIiPJe69DgfpE,614
+flipt/evaluation/__init__.py,sha256=rDXQHPiww5h3ffISrPdRAWghIQQyxRvaF-Z1aQBlrAw,744
+flipt/evaluation/async_evaluation_client.py,sha256=AZqbw-qehwCGwTigHOv8we-Wowmb7gjqYM6imRQlNXY,2207
+flipt/evaluation/models.py,sha256=xzxSibS52EQ8Q5JmUSPsJrInvUgyLItAeezgXtFzuOw,2108
+flipt/evaluation/sync_evaluation_client.py,sha256=E2bN5Emzm8ZslKWdp79G07hED43CVDzF8YLUU5KRHuc,2143
+flipt/exceptions.py,sha256=8-D9K4yRWRBK0hG9eMehU8Syq4RLfcmHT8E8-j-hl6I,368
+flipt/flags/__init__.py,sha256=94-RL_F8ZKFVfx1DECkM08lvJlHDI2vfHSpXxmSrFfQ,252
+flipt/flags/async_flag_client.py,sha256=ivmInMViYkvKSF-5TrERJ4P_he_yBOVfux2igeuIpMc,1945
+flipt/flags/models.py,sha256=y4SDmaSF3mZOHx-y3au7KzPGXj52PZ6ETCJcMuNUplc,701
+flipt/flags/sync_flag_client.py,sha256=kci-NLNfyYy4RwTG0WSLWbCuXMc19ep9Ri9wsdsZGrg,1897
+flipt/models.py,sha256=oEUte_vQqGzWNOCeQTBFP5MxAWAZEDdkjBVhZLTpDvE,567
+flipt/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+flipt/sync_client.py,sha256=C8SDP1LQ6IgSE2873KdiT5IiagKeinPDrkIa_2szkcE,590
+flipt-1.3.0.dist-info/METADATA,sha256=B_XIaWrs2P2SLFtufcQwqceYCrsdl7gTrw_26bvHBkg,1684
+flipt-1.3.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+flipt-1.3.0.dist-info/entry_points.txt,sha256=d-DgzOMENNfQ2VNMOztEgFpFxFffuOcwGl6KXc-ThuA,37
+flipt-1.3.0.dist-info/RECORD,,

flipt-1.3.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.8.1
+Root-Is-Purelib: true
+Tag: py3-none-any

flipt-1.3.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+test=scripts:test
+