struai 1.0.1__tar.gz → 1.0.4__tar.gz

{struai-1.0.1 → struai-1.0.4}/.github/workflows/release.yml

@@ -93,6 +93,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          ref: ${{ needs.release.outputs.released == 'true' && format('v{0}', needs.release.outputs.version) || github.ref }}
 
       - name: Set up Python
         uses: actions/setup-python@v5
@@ -120,6 +122,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          ref: ${{ needs.release.outputs.released == 'true' && format('v{0}', needs.release.outputs.version) || github.ref }}
 
       - name: Set up Node.js
         uses: actions/setup-node@v4

struai-1.0.4/CHANGELOG.md

@@ -0,0 +1,47 @@
+# CHANGELOG
+
+<!-- version list -->
+
+## v1.0.4 (2026-02-04)
+
+### Bug Fixes
+
+- **ci**: Checkout release tag for publish jobs
+  ([`6b78004`](https://github.com/bhoshaga/struai/commit/6b78004629cee3dff309836f7879da417dd69ac9))
+
+
+## v1.0.3 (2026-02-04)
+
+### Bug Fixes
+
+- Trigger release v1.0.3
+  ([`a611906`](https://github.com/bhoshaga/struai/commit/a611906590f693d9222b2b95aa2c42830e92c156))
+
+### Documentation
+
+- Clarify auth and endpoints
+  ([`9703efe`](https://github.com/bhoshaga/struai/commit/9703efe1354168cb32d3ed6eacea642e22bea593))
+
+
+## v1.0.2 (2026-02-04)
+
+### Bug Fixes
+
+- **ci**: Add publish_only option for re-publishing
+  ([`0806b1e`](https://github.com/bhoshaga/struai/commit/0806b1eb6dba6d518df9f43a199b9255d1776d6a))
+
+- **ci**: Consolidate to single release workflow
+  ([`91e94b0`](https://github.com/bhoshaga/struai/commit/91e94b00f5eb6e123adb2cfae01a473ed4cd5cbd))
+
+
+## v1.0.1 (2026-02-04)
+
+### Bug Fixes
+
+- **ci**: Include publish jobs directly in release workflow
+  ([`02436eb`](https://github.com/bhoshaga/struai/commit/02436eb55c63cbaa54eac8ca456a54d30125fada))
+
+
+## v1.0.0 (2026-02-04)
+
+- Initial Release

{struai-1.0.1 → struai-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: struai
-Version: 1.0.1
+Version: 1.0.4
 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 → struai-1.0.4}/README.md

@@ -10,13 +10,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)
@@ -44,6 +51,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.
@@ -86,9 +136,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 → struai-1.0.4}/js/README.md

@@ -12,13 +12,16 @@ npm install struai
 
 ## Quick Start
 
+Get an API key from `stru.ai` and set `STRUAI_API_KEY`.
+
 ```typescript
 import { StruAI } from 'struai';
 
-const client = new StruAI({ apiKey: 'sk-xxx' });
+// Get an API key from stru.ai and set STRUAI_API_KEY
+const client = new StruAI({ apiKey: process.env.STRUAI_API_KEY! });
 
 // Optional: override base URL (http://localhost:8000 or http://localhost:8000/v1)
-const local = new StruAI({ apiKey: 'sk-xxx', baseUrl: 'http://localhost:8000' });
+const local = new StruAI({ apiKey: process.env.STRUAI_API_KEY!, baseUrl: 'http://localhost:8000' });
 ```
 
 ## Tier 1: Raw Detection ($0.02/page)
@@ -68,6 +71,31 @@ const entities = await project.entities.list({ type: 'Component', limit: 50 });
 const entity = await project.entities.get('ent_abc123');
 ```
 
+## 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`
+
 ## License
 
 MIT

{struai-1.0.1 → struai-1.0.4}/js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "struai",
-  "version": "1.0.1",
+  "version": "1.0.4",
   "description": "StruAI Drawing Analysis SDK - AI-powered construction drawing analysis",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

{struai-1.0.1 → struai-1.0.4}/js/src/index.ts

@@ -5,7 +5,7 @@
  * ```typescript
  * import { StruAI } from 'struai';
  *
- * const client = new StruAI({ apiKey: 'sk-xxx' });
+ * const client = new StruAI({ apiKey: process.env.STRUAI_API_KEY });
  *
  * // Tier 1: Raw detection
  * const result = await client.drawings.analyze('structural.pdf', { page: 4 });

{struai-1.0.1 → struai-1.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "struai"
-version = "1.0.1"
+version = "1.0.4"
 description = "StruAI Drawing Analysis SDK - AI-powered construction drawing analysis"
 readme = "README.md"
 license = "MIT"

{struai-1.0.1 → struai-1.0.4}/src/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-1.0.1 → struai-1.0.4}/src/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-1.0.1 → struai-1.0.4}/src/struai/_version.py

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

struai-1.0.1/CHANGELOG.md

@@ -1,15 +0,0 @@
-# CHANGELOG
-
-<!-- version list -->
-
-## v1.0.1 (2026-02-04)
-
-### Bug Fixes
-
-- **ci**: Include publish jobs directly in release workflow
-  ([`02436eb`](https://github.com/bhoshaga/struai/commit/02436eb55c63cbaa54eac8ca456a54d30125fada))
-
-
-## v1.0.0 (2026-02-04)
-
-- Initial Release