studyfetch-sdk 0.1.0a8__py3-none-any.whl → 0.1.0a10__py3-none-any.whl

studyfetch_sdk/_client.py

@@ -88,7 +88,7 @@ class StudyfetchSDK(SyncAPIClient):
         if base_url is None:
             base_url = os.environ.get("STUDYFETCH_SDK_BASE_URL")
         if base_url is None:
-            base_url = f"https://api.example.com"
+            base_url = f"https://studyfetchapi.com"
 
         super().__init__(
             version=__version__,
@@ -256,7 +256,7 @@ class AsyncStudyfetchSDK(AsyncAPIClient):
         if base_url is None:
             base_url = os.environ.get("STUDYFETCH_SDK_BASE_URL")
         if base_url is None:
-            base_url = f"https://api.example.com"
+            base_url = f"https://studyfetchapi.com"
 
         super().__init__(
             version=__version__,

studyfetch_sdk/_version.py

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

{studyfetch_sdk-0.1.0a8.dist-info → studyfetch_sdk-0.1.0a10.dist-info}/METADATA

@@ -1,10 +1,10 @@
 Metadata-Version: 2.3
 Name: studyfetch_sdk
-Version: 0.1.0a8
+Version: 0.1.0a10
 Summary: The official Python library for the studyfetch-sdk API
 Project-URL: Homepage, https://github.com/GoStudyFetchGo/studyfetch-sdk-python
 Project-URL: Repository, https://github.com/GoStudyFetchGo/studyfetch-sdk-python
-Author: Studyfetch SDK
+Author-email: Studyfetch SDK <support@studyfetch.com>
 License: Apache-2.0
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -46,7 +46,7 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 ## Documentation
 
-The full API of this library can be found in [api.md](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/tree/main/api.md).
+The REST API documentation can be found on [studyfetch.com](https://studyfetch.com/docs). The full API of this library can be found in [api.md](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/tree/main/api.md).
 
 ## Installation
 
@@ -67,7 +67,13 @@ client = StudyfetchSDK(
     api_key=os.environ.get("STUDYFETCH_SDK_API_KEY"),  # This is the default and can be omitted
 )
 
-materials = client.v1.materials.list()
+component = client.v1.components.create(
+    config={"model": "gpt-4o-mini-2024-07-18"},
+    name="My Study Component",
+    origin="api",
+    type="flashcards",
+)
+print(component._id)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -90,7 +96,13 @@ client = AsyncStudyfetchSDK(
 
 
 async def main() -> None:
-    materials = await client.v1.materials.list()
+    component = await client.v1.components.create(
+        config={"model": "gpt-4o-mini-2024-07-18"},
+        name="My Study Component",
+        origin="api",
+        type="flashcards",
+    )
+    print(component._id)
 
 
 asyncio.run(main())
@@ -122,7 +134,13 @@ async def main() -> None:
         api_key="My API Key",
         http_client=DefaultAioHttpClient(),
     ) as client:
-        materials = await client.v1.materials.list()
+        component = await client.v1.components.create(
+            config={"model": "gpt-4o-mini-2024-07-18"},
+            name="My Study Component",
+            origin="api",
+            type="flashcards",
+        )
+        print(component._id)
 
 
 asyncio.run(main())
@@ -187,7 +205,12 @@ from studyfetch_sdk import StudyfetchSDK
 client = StudyfetchSDK()
 
 try:
-    client.v1.materials.list()
+    client.v1.components.create(
+        config={"model": "gpt-4o-mini-2024-07-18"},
+        name="My Study Component",
+        origin="api",
+        type="flashcards",
+    )
 except studyfetch_sdk.APIConnectionError as e:
     print("The server could not be reached")
     print(e.__cause__)  # an underlying Exception, likely raised within httpx.
@@ -230,7 +253,12 @@ client = StudyfetchSDK(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).v1.materials.list()
+client.with_options(max_retries=5).v1.components.create(
+    config={"model": "gpt-4o-mini-2024-07-18"},
+    name="My Study Component",
+    origin="api",
+    type="flashcards",
+)
 ```
 
 ### Timeouts
@@ -253,7 +281,12 @@ client = StudyfetchSDK(
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).v1.materials.list()
+client.with_options(timeout=5.0).v1.components.create(
+    config={"model": "gpt-4o-mini-2024-07-18"},
+    name="My Study Component",
+    origin="api",
+    type="flashcards",
+)
 ```
 
 On timeout, an `APITimeoutError` is thrown.
@@ -294,11 +327,18 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from studyfetch_sdk import StudyfetchSDK
 
 client = StudyfetchSDK()
-response = client.v1.materials.with_raw_response.list()
+response = client.v1.components.with_raw_response.create(
+    config={
+        "model": "gpt-4o-mini-2024-07-18"
+    },
+    name="My Study Component",
+    origin="api",
+    type="flashcards",
+)
 print(response.headers.get('X-My-Header'))
 
-material = response.parse()  # get the object that `v1.materials.list()` would have returned
-print(material)
+component = response.parse()  # get the object that `v1.components.create()` would have returned
+print(component._id)
 ```
 
 These methods return an [`APIResponse`](https://github.com/GoStudyFetchGo/studyfetch-sdk-python/tree/main/src/studyfetch_sdk/_response.py) object.
@@ -312,7 +352,12 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.v1.materials.with_streaming_response.list() as response:
+with client.v1.components.with_streaming_response.create(
+    config={"model": "gpt-4o-mini-2024-07-18"},
+    name="My Study Component",
+    origin="api",
+    type="flashcards",
+) as response:
     print(response.headers.get("X-My-Header"))
 
     for line in response.iter_lines():

{studyfetch_sdk-0.1.0a8.dist-info → studyfetch_sdk-0.1.0a10.dist-info}/RECORD

@@ -1,6 +1,6 @@
 studyfetch_sdk/__init__.py,sha256=RDyNe4WTXHp7ELTihsfx-JAW6kY4v_inAdPWMACRXUU,2685
 studyfetch_sdk/_base_client.py,sha256=_ErYxBDM7URgEvuFcse8LJMKz0x_XK1Ni55WzZgrz_I,66930
-studyfetch_sdk/_client.py,sha256=WNCH0GxPelZPmS2JOkieotnrVkXHAYZirHd293PYpOc,15044
+studyfetch_sdk/_client.py,sha256=LdmGGYJBA4OMpyjaL7xSj9S2ZzNVlpS_zeLaa24Dh0Y,15048
 studyfetch_sdk/_compat.py,sha256=VWemUKbj6DDkQ-O4baSpHVLJafotzeXmCQGJugfVTIw,6580
 studyfetch_sdk/_constants.py,sha256=S14PFzyN9-I31wiV7SmIlL5Ga0MLHxdvegInGdXH7tM,462
 studyfetch_sdk/_exceptions.py,sha256=19gq_huoBWNcc8dc3YLQHCjkkmixKafZmW2GqVGlmCs,3234
@@ -11,7 +11,7 @@ studyfetch_sdk/_resource.py,sha256=y0aoAqMIYwTAwStuxbpO8XpTPnrSNQQ_ZcgiH5xcntg,1
 studyfetch_sdk/_response.py,sha256=6ph8tSkqF5pNbTo_2Zhizhq2O-Eb67TcksHwyg3aXdc,28864
 studyfetch_sdk/_streaming.py,sha256=HZoENuPVzWhBn24eH3lnMCvRbWN0EPwvhWYfdlJfw0A,10128
 studyfetch_sdk/_types.py,sha256=6nvqHGarRGuhs_FL8tJ8sGXXD8XWajNynT2K78GxRUI,6205
-studyfetch_sdk/_version.py,sha256=Vf6gzaBS9CUgMitt7McNjZ6uRx010I7u4yd1TX0pF4w,174
+studyfetch_sdk/_version.py,sha256=2RMmEarsUmjhmJ2q-V2DRZhuNbc2P2-fxWoUuZRsrbE,175
 studyfetch_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 studyfetch_sdk/_utils/__init__.py,sha256=PNZ_QJuzZEgyYXqkO1HVhGkj5IU9bglVUcw7H-Knjzw,2062
 studyfetch_sdk/_utils/_logs.py,sha256=EoZgOiIkpf2WB_0Ts0Ti7G3o_25v7IsPf_q-yEU6sbY,798
@@ -116,7 +116,7 @@ studyfetch_sdk/types/v1/scenarios/component_update_params.py,sha256=_Rs0wRJtrLMK
 studyfetch_sdk/types/v1/scenarios/submissions/__init__.py,sha256=OKfJYcKb4NObdiRObqJV_dOyDQ8feXekDUge2o_4pXQ,122
 studyfetch_sdk/types/v1/tests/__init__.py,sha256=OKfJYcKb4NObdiRObqJV_dOyDQ8feXekDUge2o_4pXQ,122
 studyfetch_sdk/types/v1/upload/__init__.py,sha256=OKfJYcKb4NObdiRObqJV_dOyDQ8feXekDUge2o_4pXQ,122
-studyfetch_sdk-0.1.0a8.dist-info/METADATA,sha256=VHHBvOO_WDRqb1TF3L3MDLENKgVAziwaKJjdgIIV8yc,14699
-studyfetch_sdk-0.1.0a8.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-studyfetch_sdk-0.1.0a8.dist-info/licenses/LICENSE,sha256=CsdbJMegH_AAWljUmVcwW0Cj_GyIm1hjw6qPqPnmdn4,11344
-studyfetch_sdk-0.1.0a8.dist-info/RECORD,,
+studyfetch_sdk-0.1.0a10.dist-info/METADATA,sha256=NfCS9XEMpju7-5DA1qFNo9MudtCCPPiTr8aGMBlXq34,15991
+studyfetch_sdk-0.1.0a10.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+studyfetch_sdk-0.1.0a10.dist-info/licenses/LICENSE,sha256=CsdbJMegH_AAWljUmVcwW0Cj_GyIm1hjw6qPqPnmdn4,11344
+studyfetch_sdk-0.1.0a10.dist-info/RECORD,,