From 0a81e7eb11d04e084642d811036e904d908f29fd Mon Sep 17 00:00:00 2001 From: Andrew Zhong <36863876+azhong-git@users.noreply.github.com> Date: Sat, 7 Jun 2025 01:44:22 -0700 Subject: [PATCH 1/5] Update README.md --- README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 4b86053..f6686df 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ +
-
+ Official SDK for real-time search and filtering via the Lightfeed API
-
-
@@ -44,13 +44,13 @@
### TypeScript / Node.js
```bash
-npm install lightfeed
+npm install @lightfeed/sdk
```
### Python
```bash
-pip install lightfeed
+pip install lightfeed-sdk
```
## Quick Start
@@ -58,7 +58,7 @@ pip install lightfeed
### TypeScript / Node.js
```typescript
-import { LightfeedClient } from 'lightfeed';
+import { LightfeedClient } from '@lightfeed/sdk';
// Initialize client with your API key
const client = new LightfeedClient({
@@ -110,7 +110,7 @@ async function searchForCompanies() {
### Python
```python
-from lightfeed import LightfeedClient, Condition, Operator
+from lightfeed-sdk import LightfeedClient, Condition, Operator
# Initialize client with your API key
client = LightfeedClient({
@@ -365,7 +365,7 @@ try {
### Python Example
```python
-from lightfeed import LightfeedError
+from lightfeed-sdk import LightfeedError
try:
records = client.get_records("your-database-id")
diff --git a/clients/python/README.md b/clients/python/README.md
index 52e7df2..f1caba8 100644
--- a/clients/python/README.md
+++ b/clients/python/README.md
@@ -19,7 +19,7 @@ pip install lightfeed
## Quick Start
```python
-from lightfeed import LightfeedClient, Condition, Operator
+from lightfeed-sdk import LightfeedClient, Condition, Operator
# Initialize client with your API key
client = LightfeedClient({
@@ -153,7 +153,7 @@ client = LightfeedClient({
The client library handles HTTP errors from the API and converts them into structured `LightfeedError` objects.
```python
-from lightfeed import LightfeedError
+from lightfeed-sdk import LightfeedError
try:
records = client.get_records("your-database-id")
@@ -176,5 +176,5 @@ For comprehensive documentation and guides, visit the [Lightfeed Documentation](
If you need assistance with your implementation:
- Email us at support@lightfeed.ai
-- Open an issue in the [GitHub repository](https://github.com/lightfeed/lightfeed)
+- Open an issue in the [GitHub repository](https://github.com/lightfeed/sdk)
- Join our [Discord community](https://discord.gg/txZ2s4pgQJ)
\ No newline at end of file
diff --git a/clients/python/pyproject.toml b/clients/python/pyproject.toml
index fa9a2fa..35472cb 100644
--- a/clients/python/pyproject.toml
+++ b/clients/python/pyproject.toml
@@ -3,9 +3,9 @@ requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"
[project]
-name = "lightfeed"
-version = "0.1.6"
-description = "Lightfeed API Client for Python"
+name = "lightfeed-sdk"
+version = "0.1.7"
+description = "Lightfeed SDK for Python"
readme = "README.md"
authors = [
{name = "Lightfeed Team", email = "support@lightfeed.ai"}
@@ -27,8 +27,8 @@ dependencies = [
]
[project.urls]
-"Homepage" = "https://github.com/lightfeed/lightfeed"
-"Bug Tracker" = "https://github.com/lightfeed/lightfeed/issues"
+"Homepage" = "https://github.com/lightfeed/sdk"
+"Bug Tracker" = "https://github.com/lightfeed/sdk/issues"
[tool.setuptools]
packages = ["lightfeed"]
diff --git a/clients/python/tests/test_client.py b/clients/python/tests/test_client.py
index 0fd33bc..4e5f750 100644
--- a/clients/python/tests/test_client.py
+++ b/clients/python/tests/test_client.py
@@ -9,7 +9,7 @@
import requests
from requests.exceptions import RequestException
-from lightfeed import LightfeedClient
+from lightfeed-sdk import LightfeedClient
from lightfeed.models import Condition, Operator, LightfeedError
diff --git a/clients/test-clients/test-npm.js b/clients/test-clients/test-npm.js
index bd3a95c..e466978 100644
--- a/clients/test-clients/test-npm.js
+++ b/clients/test-clients/test-npm.js
@@ -1,7 +1,7 @@
// Test script for the Lightfeed TypeScript client
require("dotenv").config({ path: ".env" });
-import { LightfeedClient } from "lightfeed";
+import { LightfeedClient } from "@lightfeed/sdk";
// Initialize client with your API key
const client = new LightfeedClient({
diff --git a/clients/test-clients/test-python.py b/clients/test-clients/test-python.py
index 0aeefce..a7507fd 100644
--- a/clients/test-clients/test-python.py
+++ b/clients/test-clients/test-python.py
@@ -3,7 +3,7 @@
import os
from dotenv import load_dotenv
-from lightfeed import LightfeedClient, Operator
+from lightfeed-sdk import LightfeedClient, Operator
# Load environment variables from .env file
load_dotenv()
diff --git a/clients/typescript/README.md b/clients/typescript/README.md
index 4bfeeda..3ee8d81 100644
--- a/clients/typescript/README.md
+++ b/clients/typescript/README.md
@@ -13,13 +13,13 @@ Official Node.js client library for interacting with the Lightfeed API. Extract,
## Installation
```bash
-npm install lightfeed
+npm install @lightfeed/sdk
```
## Quick Start
```typescript
-import { LightfeedClient } from 'lightfeed';
+import { LightfeedClient } from '@lightfeed/sdk';
// Initialize client with your API key
const client = new LightfeedClient({
@@ -183,5 +183,5 @@ For comprehensive documentation and guides, visit the [Lightfeed Documentation](
If you need assistance with your implementation:
- Email us at support@lightfeed.ai
-- Open an issue in the [GitHub repository](https://github.com/lightfeed/lightfeed)
+- Open an issue in the [GitHub repository](https://github.com/lightfeed/sdk)
- Join our [Discord community](https://discord.gg/txZ2s4pgQJ)
\ No newline at end of file
diff --git a/clients/typescript/package.json b/clients/typescript/package.json
index e993d1c..89f65de 100644
--- a/clients/typescript/package.json
+++ b/clients/typescript/package.json
@@ -1,7 +1,7 @@
{
- "name": "lightfeed",
- "version": "0.1.6",
- "description": "Lightfeed API Client for Node.js",
+ "name": "@lightfeed/sdk",
+ "version": "0.1.7",
+ "description": "Lightfeed SDK for Node.js",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"scripts": {
@@ -24,7 +24,7 @@
"license": "MIT",
"repository": {
"type": "git",
- "url": "https://github.com/lightfeed/lightfeed"
+ "url": "https://github.com/lightfeed/sdk"
},
"homepage": "https://www.lightfeed.ai/docs/apis/",
"devDependencies": {
From 6469b660159430688e548739cfc0ce67379cf5d9 Mon Sep 17 00:00:00 2001
From: Andrew Zhong