struai 1.0.1__py3-none-any.whl → 1.0.2__py3-none-any.whl

struai/__init__.py

@@ -1,9 +1,10 @@
 """StruAI Python SDK - Drawing Analysis API client.
 
 Example:
+    >>> import os
     >>> from struai import StruAI
     >>>
-    >>> client = StruAI(api_key="sk-xxx")
+    >>> client = StruAI(api_key=os.environ["STRUAI_API_KEY"])
     >>>
     >>> # Tier 1: Raw detection ($0.02/page)
     >>> result = client.drawings.analyze("plans.pdf", page=4)

struai/_client.py

@@ -21,7 +21,8 @@ class StruAI(BaseClient):
         max_retries: Max retry attempts for failed requests. Default 2.
 
     Example:
-        >>> client = StruAI(api_key="sk-xxx")
+        >>> import os
+        >>> client = StruAI(api_key=os.environ["STRUAI_API_KEY"])
         >>>
         >>> # Tier 1: Raw detection
         >>> result = client.drawings.analyze("structural.pdf", page=4)
@@ -72,7 +73,8 @@ class AsyncStruAI(AsyncBaseClient):
     """Async StruAI client for drawing analysis API.
 
     Example:
-        >>> async with AsyncStruAI(api_key="sk-xxx") as client:
+        >>> import os
+        >>> async with AsyncStruAI(api_key=os.environ["STRUAI_API_KEY"]) as client:
         ...     result = await client.drawings.analyze("structural.pdf", page=4)
         ...
         ...     project = await client.projects.create("Building A")

struai/_version.py

@@ -1,2 +1,2 @@
 """Version information."""
-__version__ = "1.0.1"
+__version__ = "1.0.2"

{struai-1.0.1.dist-info → struai-1.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: struai
-Version: 1.0.1
+Version: 1.0.2
 Summary: StruAI Drawing Analysis SDK - AI-powered construction drawing analysis
 Project-URL: Homepage, https://struai.com
 Project-URL: Documentation, https://docs.struai.com/python
@@ -42,13 +42,20 @@ pip install struai
 
 ## Quick Start
 
+Get an API key from `stru.ai` and set it as an environment variable:
+
+```bash
+export STRUAI_API_KEY="YOUR_API_KEY"
+```
+
 ```python
+import os
 from struai import StruAI
 
-client = StruAI(api_key="sk-xxx")  # or set STRUAI_API_KEY env var
+client = StruAI(api_key=os.environ["STRUAI_API_KEY"])
 
 # Optional: override base URL (http://localhost:8000 or http://localhost:8000/v1)
-client = StruAI(api_key="sk-xxx", base_url="http://localhost:8000")
+client = StruAI(api_key=os.environ["STRUAI_API_KEY"], base_url="http://localhost:8000")
 ```
 
 ## Tier 1: Raw Detection ($0.02/page)
@@ -76,6 +83,49 @@ drawing = client.drawings.get("drw_7f8a9b2c")
 client.drawings.delete("drw_7f8a9b2c")
 ```
 
+## HTTP Endpoints (Reference)
+
+All endpoints are under `/v1`. Use `Authorization: Bearer <API_KEY>`.
+
+Tier 1 (raw detection):
+- `POST /v1/drawings` — multipart form with `file` (PDF) and `page` (1-indexed)
+- `GET /v1/drawings/{id}`
+- `DELETE /v1/drawings/{id}`
+
+Tier 2 (graph + search):
+- `POST /v1/projects`
+- `GET /v1/projects`
+- `GET /v1/projects/{id}`
+- `DELETE /v1/projects/{id}`
+- `POST /v1/projects/{project_id}/sheets` — multipart form with `file` + `page`
+- `GET /v1/projects/{project_id}/jobs/{job_id}`
+- `GET /v1/projects/{project_id}/sheets`
+- `GET /v1/projects/{project_id}/sheets/{sheet_id}`
+- `DELETE /v1/projects/{project_id}/sheets/{sheet_id}`
+- `POST /v1/projects/{project_id}/search`
+- `POST /v1/projects/{project_id}/query`
+- `GET /v1/projects/{project_id}/entities`
+- `GET /v1/projects/{project_id}/entities/{entity_id}`
+- `GET /v1/projects/{project_id}/relationships`
+
+Example (raw detection):
+
+```bash
+curl -X POST "https://api.stru.ai/v1/drawings" \
+  -H "Authorization: Bearer YOUR_API_KEY" \
+  -F "file=@structural.pdf" \
+  -F "page=4"
+```
+
+Example (project sheet ingestion):
+
+```bash
+curl -X POST "https://api.stru.ai/v1/projects/{project_id}/sheets" \
+  -H "Authorization: Bearer YOUR_API_KEY" \
+  -F "file=@structural.pdf" \
+  -F "page=4"
+```
+
 ## Tier 2: Graph + Search ($0.15/page)
 
 Full pipeline: detection → LLM enrichment → knowledge graph → semantic search.
@@ -118,9 +168,10 @@ entity = project.entities.get("ent_abc123")
 ## Async Support
 
 ```python
+import os
 from struai import AsyncStruAI
 
-async with AsyncStruAI(api_key="sk-xxx") as client:
+async with AsyncStruAI(api_key=os.environ["STRUAI_API_KEY"]) as client:
     # Tier 1
     result = await client.drawings.analyze("structural.pdf", page=4)
 

{struai-1.0.1.dist-info → struai-1.0.2.dist-info}/RECORD

@@ -1,8 +1,8 @@
-struai/__init__.py,sha256=3YTAjICfleWQh33O7y-yVqAJ8k9Pn2eU2epzrroKqt4,2274
+struai/__init__.py,sha256=PDKqtP7iT2Gibhm-CR08pjFXwkBnC5LhjvjbISmk-rs,2312
 struai/_base.py,sha256=JiAxWI1PMmIFVr9v_hBABra8m2fRkEvBp7d2Vc-5IAk,11208
-struai/_client.py,sha256=WOcGC7LjaG469shx1YX2GCt0yJs-Ew-vOrxsqUmVmHM,3542
+struai/_client.py,sha256=jc1WBRQIB4qjxC4IgA4CtIjFQ--tORJhTPlIcsV56yc,3626
 struai/_exceptions.py,sha256=GK0aVnOdkmcFaO16e0lzj9S2NmnTjQiy5H6nH6yDV24,2021
-struai/_version.py,sha256=da8k-y4StnRTawPjG6KLx2cylvLgrpCSR6eZl8UgnKA,49
+struai/_version.py,sha256=vO6OYruC7WUn0d2gyxEwUnT-rvPnMZ9JtPv1h8Fu25w,49
 struai/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 struai/models/__init__.py,sha256=qA_e6ZGG7Uhq9aLX2LeXlnUuV8VE6ur3OCFOPcj1oco,1220
 struai/models/common.py,sha256=0Ox9PiuyRoyWH5vbSTfjm2nCWt_pblWH7kJso8nMVuE,592
@@ -13,6 +13,6 @@ struai/models/search.py,sha256=UL3RYsAidS1zdV4lKiwNcHcAIjzyi8dgAQodowjzh58,1324
 struai/resources/__init__.py,sha256=_JT_8OrvVcJ4yHmvZnsqYj4ej8pVg5lKSPKIcgQTCZk,183
 struai/resources/drawings.py,sha256=b3C7CHS-p8CpGBtKl_dvLeUFDJ3g8HjlLBA4II0HsT4,3957
 struai/resources/projects.py,sha256=_KRHO6ByBN_W-STlaAhVljLt9F3Yh9xzV5Piahc50FQ,19501
-struai-1.0.1.dist-info/METADATA,sha256=pVsCT9ov986VJ3flFsJhCGwMIGrYlO_ITbdoPJ1_gV8,4460
-struai-1.0.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-struai-1.0.1.dist-info/RECORD,,
+struai-1.0.2.dist-info/METADATA,sha256=TXK36DlWMFkafqOY5jlYdnQrKm5ATimV1bNakz_otpo,5904
+struai-1.0.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+struai-1.0.2.dist-info/RECORD,,