diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 20b4eca..7c100b5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,6 +1,6 @@ name: CI Tests -# CI workflow for lightfeed/lightfeed repository +# CI workflow for lightfeed/sdk repository # Runs tests for both Python and TypeScript clients on every push to main on: diff --git a/.github/workflows/release-python.yml b/.github/workflows/release-python.yml index 436b3f0..54e9407 100644 --- a/.github/workflows/release-python.yml +++ b/.github/workflows/release-python.yml @@ -75,6 +75,6 @@ jobs: ${{ env.CHANGES }} - For full details, see the [CHANGELOG](https://github.com/lightfeed/lightfeed/blob/main/CHANGELOG.md). + For full details, see the [CHANGELOG](https://github.com/lightfeed/sdk/blob/main/CHANGELOG.md). draft: false prerelease: false diff --git a/.github/workflows/release-typescript.yml b/.github/workflows/release-typescript.yml index e02724d..0a0ef32 100644 --- a/.github/workflows/release-typescript.yml +++ b/.github/workflows/release-typescript.yml @@ -69,6 +69,6 @@ jobs: ${{ env.CHANGES }} - For full details, see the [CHANGELOG](https://github.com/lightfeed/lightfeed/blob/main/CHANGELOG.md). + For full details, see the [CHANGELOG](https://github.com/lightfeed/sdk/blob/main/CHANGELOG.md). draft: false prerelease: false diff --git a/CHANGELOG.md b/CHANGELOG.md index 2e545fb..773c1a7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] ### Added +## [py-0.1.7 & ts-0.1.7] - 2025-06-07 +### Changed +- Changed github project to lightfeed/sdk +- Changed python package name to lightfeed-sdk +- Changed npm package name to @lightfeed/sdk + ## [py-0.1.6 & ts-0.1.6] - 2025-06-04 ### Changed - Changed timestamp fields to created_at, changed_at and synced_at diff --git a/README.md b/README.md index 4b86053..93c5b5b 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,22 @@ +

+ Lightfeed Logo + Lightfeed SDK +

+

- Lightfeed Logo + Official SDK for real-time search and filtering via the Lightfeed API

- - npm - - PyPI - - + npm + + PyPI + + Test status (main branch) - - License + + License

@@ -26,17 +31,9 @@

-# ⚡️ Lightfeed - -Official Typescript/Python client library for interacting with the Lightfeed API. This SDK enables real-time search and filtering of your extracted web data. - -

- Lightfeed Extract -

- ## Features -- Simple and intuitive interface for accessing Lightfeed APIs +- Simple and intuitive interface for accessing Lightfeed API - Semantic search and advanced filtering capabilities - Full TypeScript/Python type definitions for better developer experience - Comprehensive error handling @@ -47,13 +44,13 @@ Official Typescript/Python client library for interacting with the Lightfeed API ### TypeScript / Node.js ```bash -npm install lightfeed +npm install @lightfeed/sdk ``` ### Python ```bash -pip install lightfeed +pip install lightfeed-sdk ``` ## Quick Start @@ -61,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({ @@ -113,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({ @@ -368,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/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": {