From 032af703c92abc6d7c2d89a438cdfdc34c57d0cb Mon Sep 17 00:00:00 2001 From: rcholic Date: Sat, 27 Dec 2025 21:27:26 -0800 Subject: [PATCH] renamed pypi name --- .github/workflows/release.yml | 6 +++--- README.md | 30 ++++++++++++++++++------------ package-lock.json | 8 ++++---- package.json | 2 +- 4 files changed, 26 insertions(+), 20 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 7d78db77..7298f7d4 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -73,11 +73,11 @@ jobs: tag_name: v${{ steps.version.outputs.version }} name: Release v${{ steps.version.outputs.version }} body: | - Release v${{ steps.version.outputs.version }} of sentience-ts - + Release v${{ steps.version.outputs.version }} of sentienceapi + ## Installation ```bash - npm install sentience-ts@${{ steps.version.outputs.version }} + npm install sentienceapi@${{ steps.version.outputs.version }} ``` draft: false prerelease: false diff --git a/README.md b/README.md index f66f5f88..fd03b147 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,19 @@ The SDK is open under ELv2; the core semantic geometry and reliability logic run ## Installation ```bash -npm install -npm run build +# Install from npm +npm install sentienceapi # Install Playwright browsers (required) npx playwright install chromium ``` +**For local development:** +```bash +npm install +npm run build +``` + ## Quick Start: Choose Your Abstraction Level Sentience SDK offers **4 levels of abstraction** - choose based on your needs: @@ -21,7 +27,7 @@ Sentience SDK offers **4 levels of abstraction** - choose based on your needs: Complete automation with natural conversation. Just describe what you want, and the agent plans and executes everything: ```typescript -import { SentienceBrowser, ConversationalAgent, OpenAIProvider } from 'sentience-ts'; +import { SentienceBrowser, ConversationalAgent, OpenAIProvider } from 'sentienceapi'; const browser = await SentienceBrowser.create({ apiKey: process.env.SENTIENCE_API_KEY }); const llm = new OpenAIProvider(process.env.OPENAI_API_KEY!, 'gpt-4o'); @@ -52,7 +58,7 @@ await browser.close(); Zero coding knowledge needed. Just write what you want in plain English: ```typescript -import { SentienceBrowser, SentienceAgent, OpenAIProvider } from 'sentience-ts'; +import { SentienceBrowser, SentienceAgent, OpenAIProvider } from 'sentienceapi'; const browser = await SentienceBrowser.create({ apiKey: process.env.SENTIENCE_API_KEY }); const llm = new OpenAIProvider(process.env.OPENAI_API_KEY!, 'gpt-4o-mini'); @@ -80,7 +86,7 @@ await browser.close(); Full control with semantic selectors. For technical users who want precision: ```typescript -import { SentienceBrowser, snapshot, find, click, typeText, press } from 'sentience-ts'; +import { SentienceBrowser, snapshot, find, click, typeText, press } from 'sentienceapi'; const browser = await SentienceBrowser.create({ apiKey: process.env.SENTIENCE_API_KEY }); await browser.getPage().goto('https://www.amazon.com'); @@ -136,7 +142,7 @@ import { OpenAIProvider, Tracer, JsonlTraceSink -} from 'sentience-ts'; +} from 'sentienceapi'; import { randomUUID } from 'crypto'; const browser = await SentienceBrowser.create({ apiKey: process.env.SENTIENCE_API_KEY }); @@ -222,7 +228,7 @@ console.log(`Total tokens: ${totalTokens}`); You can also use the tracer directly for custom workflows: ```typescript -import { Tracer, JsonlTraceSink } from 'sentience-ts'; +import { Tracer, JsonlTraceSink } from 'sentienceapi'; import { randomUUID } from 'crypto'; const runId = randomUUID(); @@ -258,7 +264,7 @@ Traces are **100% compatible** with Python SDK traces - use the same tools to an ### Google Search (6 lines of code) ```typescript -import { SentienceBrowser, SentienceAgent, OpenAIProvider } from 'sentience-ts'; +import { SentienceBrowser, SentienceAgent, OpenAIProvider } from 'sentienceapi'; const browser = await SentienceBrowser.create({ apiKey: apiKey }); const llm = new OpenAIProvider(openaiKey, 'gpt-4o-mini'); @@ -278,7 +284,7 @@ await browser.close(); ### Using Anthropic Claude Instead of GPT ```typescript -import { SentienceAgent, AnthropicProvider } from 'sentience-ts'; +import { SentienceAgent, AnthropicProvider } from 'sentienceapi'; // Swap OpenAI for Anthropic - same API! const llm = new AnthropicProvider( @@ -315,7 +321,7 @@ await agent.act("Click the 'Add to Cart' button"); ```bash # Install core SDK -npm install sentience-ts +npm install sentienceapi # Install LLM provider (choose one or both) npm install openai # For GPT-4, GPT-4o, GPT-4o-mini @@ -747,7 +753,7 @@ const browser = new SentienceBrowser(); await browser.start(); // With agent -import { SentienceAgent, OpenAIProvider } from 'sentience-ts'; +import { SentienceAgent, OpenAIProvider } from 'sentienceapi'; const browser = new SentienceBrowser( 'your-api-key', @@ -784,7 +790,7 @@ Inject pre-recorded authentication sessions (cookies + localStorage) to start yo ```typescript // Workflow 1: Inject pre-recorded session from file -import { SentienceBrowser, saveStorageState } from 'sentience-ts'; +import { SentienceBrowser, saveStorageState } from 'sentienceapi'; // Save session after manual login const browser = new SentienceBrowser(); diff --git a/package-lock.json b/package-lock.json index 05f719c5..4671d077 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { - "name": "sentience-ts", - "version": "0.12.1", + "name": "sentienceapi", + "version": "0.90.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "sentience-ts", - "version": "0.12.1", + "name": "sentienceapi", + "version": "0.90.0", "license": "MIT", "dependencies": { "playwright": "^1.40.0", diff --git a/package.json b/package.json index f7539a56..3a01239f 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "sentience-ts", + "name": "sentienceapi", "version": "0.90.0", "description": "TypeScript SDK for Sentience AI Agent Browser Automation", "main": "dist/index.js",