payi 0.1.0a18__tar.gz → 0.1.0a19__tar.gz

payi-0.1.0a19/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0-alpha.19"
+}

{payi-0.1.0a18 → payi-0.1.0a19}/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.1.0-alpha.19 (2024-08-09)
+
+Full Changelog: [v0.1.0-alpha.18...v0.1.0-alpha.19](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.18...v0.1.0-alpha.19)
+
+### Features
+
+* **api:** update via SDK Studio ([#89](https://github.com/Pay-i/pay-i-python/issues/89)) ([b031428](https://github.com/Pay-i/pay-i-python/commit/b03142879e9d1798d08288578d078eab98e86353))
+
+
+### Chores
+
+* **ci:** bump prism mock server version ([#91](https://github.com/Pay-i/pay-i-python/issues/91)) ([6cd2937](https://github.com/Pay-i/pay-i-python/commit/6cd29379f24f7a7d261ed6beea8e4833e01eacfd))
+* **internal:** ensure package is importable in lint cmd ([#92](https://github.com/Pay-i/pay-i-python/issues/92)) ([5af85e5](https://github.com/Pay-i/pay-i-python/commit/5af85e57dac94be4da96b45b406e683701150365))
+
 ## 0.1.0-alpha.18 (2024-08-08)
 
 Full Changelog: [v0.1.0-alpha.17...v0.1.0-alpha.18](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.17...v0.1.0-alpha.18)

{payi-0.1.0a18 → payi-0.1.0a19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: payi
-Version: 0.1.0a18
+Version: 0.1.0a19
 Summary: The official Python library for the payi API
 Project-URL: Homepage, https://github.com/Pay-i/pay-i-python
 Project-URL: Repository, https://github.com/Pay-i/pay-i-python
@@ -63,7 +63,7 @@ from payi import Payi
 
 client = Payi(
     # This is the default and can be omitted
-    payi_api_key=os.environ.get("PAYI_API_KEY"),
+    api_key=os.environ.get("PAYI_API_KEY"),
 )
 
 budget_response = client.budgets.create(
@@ -73,10 +73,10 @@ budget_response = client.budgets.create(
 print(budget_response.request_id)
 ```
 
-While you can provide a `payi_api_key` keyword argument,
+While you can provide an `api_key` keyword argument,
 we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-to add `PAYI_API_KEY="My Payi API Key"` to your `.env` file
-so that your Payi API Key is not stored in source control.
+to add `PAYI_API_KEY="My API Key"` to your `.env` file
+so that your API Key is not stored in source control.
 
 ## Async usage
 
@@ -89,7 +89,7 @@ from payi import AsyncPayi
 
 client = AsyncPayi(
     # This is the default and can be omitted
-    payi_api_key=os.environ.get("PAYI_API_KEY"),
+    api_key=os.environ.get("PAYI_API_KEY"),
 )
 
 

{payi-0.1.0a18 → payi-0.1.0a19}/README.md

@@ -29,7 +29,7 @@ from payi import Payi
 
 client = Payi(
     # This is the default and can be omitted
-    payi_api_key=os.environ.get("PAYI_API_KEY"),
+    api_key=os.environ.get("PAYI_API_KEY"),
 )
 
 budget_response = client.budgets.create(
@@ -39,10 +39,10 @@ budget_response = client.budgets.create(
 print(budget_response.request_id)
 ```
 
-While you can provide a `payi_api_key` keyword argument,
+While you can provide an `api_key` keyword argument,
 we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-to add `PAYI_API_KEY="My Payi API Key"` to your `.env` file
-so that your Payi API Key is not stored in source control.
+to add `PAYI_API_KEY="My API Key"` to your `.env` file
+so that your API Key is not stored in source control.
 
 ## Async usage
 
@@ -55,7 +55,7 @@ from payi import AsyncPayi
 
 client = AsyncPayi(
     # This is the default and can be omitted
-    payi_api_key=os.environ.get("PAYI_API_KEY"),
+    api_key=os.environ.get("PAYI_API_KEY"),
 )
 
 

{payi-0.1.0a18 → payi-0.1.0a19}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "payi"
-version = "0.1.0-alpha.18"
+version = "0.1.0-alpha.19"
 description = "The official Python library for the payi API"
 dynamic = ["readme"]
 license = "Apache-2.0"
@@ -76,10 +76,13 @@ format = { chain = [
 "lint" = { chain = [
   "check:ruff",
   "typecheck",
+  "check:importable",
 ]}
 "check:ruff" = "ruff check ."
 "fix:ruff" = "ruff check --fix ."
 
+"check:importable" = "python -c 'import payi'"
+
 typecheck = { chain = [
   "typecheck:pyright",
   "typecheck:mypy"

{payi-0.1.0a18 → payi-0.1.0a19}/src/payi/_client.py

@@ -54,12 +54,12 @@ class Payi(SyncAPIClient):
     with_streaming_response: PayiWithStreamedResponse
 
     # client options
-    payi_api_key: str
+    api_key: str
 
     def __init__(
         self,
         *,
-        payi_api_key: str | None = None,
+        api_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -81,15 +81,15 @@ class Payi(SyncAPIClient):
     ) -> None:
         """Construct a new synchronous payi client instance.
 
-        This automatically infers the `payi_api_key` argument from the `PAYI_API_KEY` environment variable if it is not provided.
+        This automatically infers the `api_key` argument from the `PAYI_API_KEY` environment variable if it is not provided.
         """
-        if payi_api_key is None:
-            payi_api_key = os.environ.get("PAYI_API_KEY")
-        if payi_api_key is None:
+        if api_key is None:
+            api_key = os.environ.get("PAYI_API_KEY")
+        if api_key is None:
             raise PayiError(
-                "The payi_api_key client option must be set either by passing payi_api_key to the client or by setting the PAYI_API_KEY environment variable"
+                "The api_key client option must be set either by passing api_key to the client or by setting the PAYI_API_KEY environment variable"
             )
-        self.payi_api_key = payi_api_key
+        self.api_key = api_key
 
         if base_url is None:
             base_url = os.environ.get("PAYI_BASE_URL")
@@ -122,8 +122,8 @@ class Payi(SyncAPIClient):
     @property
     @override
     def auth_headers(self) -> dict[str, str]:
-        payi_api_key = self.payi_api_key
-        return {"Authorization": payi_api_key}
+        api_key = self.api_key
+        return {"Authorization": api_key}
 
     @property
     @override
@@ -137,7 +137,7 @@ class Payi(SyncAPIClient):
     def copy(
         self,
         *,
-        payi_api_key: str | None = None,
+        api_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.Client | None = None,
@@ -171,7 +171,7 @@ class Payi(SyncAPIClient):
 
         http_client = http_client or self._client
         return self.__class__(
-            payi_api_key=payi_api_key or self.payi_api_key,
+            api_key=api_key or self.api_key,
             base_url=base_url or self.base_url,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,
@@ -228,12 +228,12 @@ class AsyncPayi(AsyncAPIClient):
     with_streaming_response: AsyncPayiWithStreamedResponse
 
     # client options
-    payi_api_key: str
+    api_key: str
 
     def __init__(
         self,
         *,
-        payi_api_key: str | None = None,
+        api_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -255,15 +255,15 @@ class AsyncPayi(AsyncAPIClient):
     ) -> None:
         """Construct a new async payi client instance.
 
-        This automatically infers the `payi_api_key` argument from the `PAYI_API_KEY` environment variable if it is not provided.
+        This automatically infers the `api_key` argument from the `PAYI_API_KEY` environment variable if it is not provided.
         """
-        if payi_api_key is None:
-            payi_api_key = os.environ.get("PAYI_API_KEY")
-        if payi_api_key is None:
+        if api_key is None:
+            api_key = os.environ.get("PAYI_API_KEY")
+        if api_key is None:
             raise PayiError(
-                "The payi_api_key client option must be set either by passing payi_api_key to the client or by setting the PAYI_API_KEY environment variable"
+                "The api_key client option must be set either by passing api_key to the client or by setting the PAYI_API_KEY environment variable"
             )
-        self.payi_api_key = payi_api_key
+        self.api_key = api_key
 
         if base_url is None:
             base_url = os.environ.get("PAYI_BASE_URL")
@@ -296,8 +296,8 @@ class AsyncPayi(AsyncAPIClient):
     @property
     @override
     def auth_headers(self) -> dict[str, str]:
-        payi_api_key = self.payi_api_key
-        return {"Authorization": payi_api_key}
+        api_key = self.api_key
+        return {"Authorization": api_key}
 
     @property
     @override
@@ -311,7 +311,7 @@ class AsyncPayi(AsyncAPIClient):
     def copy(
         self,
         *,
-        payi_api_key: str | None = None,
+        api_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.AsyncClient | None = None,
@@ -345,7 +345,7 @@ class AsyncPayi(AsyncAPIClient):
 
         http_client = http_client or self._client
         return self.__class__(
-            payi_api_key=payi_api_key or self.payi_api_key,
+            api_key=api_key or self.api_key,
             base_url=base_url or self.base_url,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,

{payi-0.1.0a18 → payi-0.1.0a19}/src/payi/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "payi"
-__version__ = "0.1.0-alpha.18"  # x-release-please-version
+__version__ = "0.1.0-alpha.19"  # x-release-please-version

{payi-0.1.0a18 → payi-0.1.0a19}/tests/conftest.py

@@ -26,7 +26,7 @@ def event_loop() -> Iterator[asyncio.AbstractEventLoop]:
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
-payi_api_key = "My Payi API Key"
+api_key = "My API Key"
 
 
 @pytest.fixture(scope="session")
@@ -35,7 +35,7 @@ def client(request: FixtureRequest) -> Iterator[Payi]:
     if not isinstance(strict, bool):
         raise TypeError(f"Unexpected fixture parameter type {type(strict)}, expected {bool}")
 
-    with Payi(base_url=base_url, payi_api_key=payi_api_key, _strict_response_validation=strict) as client:
+    with Payi(base_url=base_url, api_key=api_key, _strict_response_validation=strict) as client:
         yield client
 
 
@@ -45,5 +45,5 @@ async def async_client(request: FixtureRequest) -> AsyncIterator[AsyncPayi]:
     if not isinstance(strict, bool):
         raise TypeError(f"Unexpected fixture parameter type {type(strict)}, expected {bool}")
 
-    async with AsyncPayi(base_url=base_url, payi_api_key=payi_api_key, _strict_response_validation=strict) as client:
+    async with AsyncPayi(base_url=base_url, api_key=api_key, _strict_response_validation=strict) as client:
         yield client