Skip to content

Commit 6ddc3ba

Browse files
azhong-gitazhong-git
authored
Update README and change npm and python project names (#14)
1 parent 3f8deeb commit 6ddc3ba

File tree

11 files changed

+46
-43
lines changed

11 files changed

+46
-43
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: CI Tests
22

3-
# CI workflow for lightfeed/lightfeed repository
3+
# CI workflow for lightfeed/sdk repository
44
# Runs tests for both Python and TypeScript clients on every push to main
55

66
on:

‎.github/workflows/release-python.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,6 @@ jobs:
7575
7676
${{ env.CHANGES }}
7777
78-
For full details, see the [CHANGELOG](https://github.com/lightfeed/lightfeed/blob/main/CHANGELOG.md).
78+
For full details, see the [CHANGELOG](https://github.com/lightfeed/sdk/blob/main/CHANGELOG.md).
7979
draft: false
8080
prerelease: false

‎.github/workflows/release-typescript.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,6 @@ jobs:
6969
7070
${{ env.CHANGES }}
7171
72-
For full details, see the [CHANGELOG](https://github.com/lightfeed/lightfeed/blob/main/CHANGELOG.md).
72+
For full details, see the [CHANGELOG](https://github.com/lightfeed/sdk/blob/main/CHANGELOG.md).
7373
draft: false
7474
prerelease: false

‎CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
88
## [Unreleased]
99
### Added
1010

11+
## [py-0.1.7 & ts-0.1.7] - 2025-06-07
12+
### Changed
13+
- Changed github project to lightfeed/sdk
14+
- Changed python package name to lightfeed-sdk
15+
- Changed npm package name to @lightfeed/sdk
16+
1117
## [py-0.1.6 & ts-0.1.6] - 2025-06-04
1218
### Changed
1319
- Changed timestamp fields to created_at, changed_at and synced_at

‎README.md‎

Lines changed: 20 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
1+
<h1 align="center">
2+
<img src="https://www.lightfeed.ai/docs/img/logo.svg" width="32" height="32" alt="Lightfeed Logo"/>
3+
Lightfeed SDK
4+
</h1>
5+
16
<p align="center">
2-
<img src="https://www.lightfeed.ai/docs/img/logo.svg" width="128" height="128" alt="Lightfeed Logo" />
7+
<strong>Official SDK for real-time search and filtering via the Lightfeed API</strong>
38
</p>
49

510
<div align="center">
6-
<a href="https://www.npmjs.com/package/lightfeed">
7-
<img src="https://img.shields.io/npm/v/lightfeed?logo=npm" alt="npm" /></a>
8-
<a href="https://pypi.org/project/lightfeed/">
9-
<img src="https://img.shields.io/pypi/v/lightfeed?logo=pypi&logoColor=white" alt="PyPI" /></a>
10-
<a href="https://github.com/lightfeed/lightfeed/actions/workflows/ci.yml">
11-
<img src="https://img.shields.io/github/actions/workflow/status/lightfeed/lightfeed/ci.yml?branch=main"
11+
<a href="https://www.npmjs.com/package/@lightfeed/sdk">
12+
<img src="https://img.shields.io/npm/v/@lightfeed/sdk?logo=npm" alt="npm" /></a>
13+
<a href="https://pypi.org/project/lightfeed-sdk/">
14+
<img src="https://img.shields.io/pypi/v/lightfeed-sdk?logo=pypi&logoColor=white" alt="PyPI" /></a>
15+
<a href="https://github.com/lightfeed/sdk/actions/workflows/ci.yml">
16+
<img src="https://img.shields.io/github/actions/workflow/status/lightfeed/sdk/ci.yml?branch=main"
1217
alt="Test status (main branch)"></a>
13-
<a href="https://github.com/lightfeed/lightfeed/blob/main/LICENSE">
14-
<img src="https://img.shields.io/github/license/lightfeed/lightfeed" alt="License" /></a>
18+
<a href="https://github.com/lightfeed/sdk/blob/main/LICENSE">
19+
<img src="https://img.shields.io/github/license/lightfeed/sdk" alt="License" /></a>
1520
</div>
1621
<div>
1722
<p align="center">
@@ -26,17 +31,9 @@
2631
</p>
2732
</div>
2833

29-
# ⚡️ Lightfeed
30-
31-
Official Typescript/Python client library for interacting with the Lightfeed API. This SDK enables real-time search and filtering of your extracted web data.
32-
33-
<p align="center">
34-
<img src="https://www.lightfeed.ai/docs/img/blog/introducing-lightfeed-extract.png" alt="Lightfeed Extract" width="100%">
35-
</p>
36-
3734
## Features
3835

39-
- Simple and intuitive interface for accessing Lightfeed APIs
36+
- Simple and intuitive interface for accessing Lightfeed API
4037
- Semantic search and advanced filtering capabilities
4138
- Full TypeScript/Python type definitions for better developer experience
4239
- Comprehensive error handling
@@ -47,21 +44,21 @@ Official Typescript/Python client library for interacting with the Lightfeed API
4744
### TypeScript / Node.js
4845

4946
```bash
50-
npm install lightfeed
47+
npm install @lightfeed/sdk
5148
```
5249

5350
### Python
5451

5552
```bash
56-
pip install lightfeed
53+
pip install lightfeed-sdk
5754
```
5855

5956
## Quick Start
6057

6158
### TypeScript / Node.js
6259

6360
```typescript
64-
import { LightfeedClient } from 'lightfeed';
61+
import { LightfeedClient } from '@lightfeed/sdk';
6562

6663
// Initialize client with your API key
6764
const client = new LightfeedClient({
@@ -113,7 +110,7 @@ async function searchForCompanies() {
113110
### Python
114111

115112
```python
116-
from lightfeed import LightfeedClient, Condition, Operator
113+
from lightfeed-sdk import LightfeedClient, Condition, Operator
117114

118115
# Initialize client with your API key
119116
client = LightfeedClient({
@@ -368,7 +365,7 @@ try {
368365
### Python Example
369366

370367
```python
371-
from lightfeed import LightfeedError
368+
from lightfeed-sdk import LightfeedError
372369

373370
try:
374371
records = client.get_records("your-database-id")

‎clients/python/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ pip install lightfeed
1919
## Quick Start
2020

2121
```python
22-
from lightfeed import LightfeedClient, Condition, Operator
22+
from lightfeed-sdk import LightfeedClient, Condition, Operator
2323

2424
# Initialize client with your API key
2525
client = LightfeedClient({
@@ -153,7 +153,7 @@ client = LightfeedClient({
153153
The client library handles HTTP errors from the API and converts them into structured `LightfeedError` objects.
154154

155155
```python
156-
from lightfeed import LightfeedError
156+
from lightfeed-sdk import LightfeedError
157157

158158
try:
159159
records = client.get_records("your-database-id")
@@ -176,5 +176,5 @@ For comprehensive documentation and guides, visit the [Lightfeed Documentation](
176176

177177
If you need assistance with your implementation:
178178
- Email us at [email protected]
179-
- Open an issue in the [GitHub repository](https://github.com/lightfeed/lightfeed)
179+
- Open an issue in the [GitHub repository](https://github.com/lightfeed/sdk)
180180
- Join our [Discord community](https://discord.gg/txZ2s4pgQJ)

‎clients/python/pyproject.toml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ requires = ["setuptools>=42", "wheel"]
33
build-backend = "setuptools.build_meta"
44

55
[project]
6-
name = "lightfeed"
7-
version = "0.1.6"
8-
description = "Lightfeed API Client for Python"
6+
name = "lightfeed-sdk"
7+
version = "0.1.7"
8+
description = "Lightfeed SDK for Python"
99
readme = "README.md"
1010
authors = [
1111
{name = "Lightfeed Team", email = "[email protected]"}
@@ -27,8 +27,8 @@ dependencies = [
2727
]
2828

2929
[project.urls]
30-
"Homepage" = "https://github.com/lightfeed/lightfeed"
31-
"Bug Tracker" = "https://github.com/lightfeed/lightfeed/issues"
30+
"Homepage" = "https://github.com/lightfeed/sdk"
31+
"Bug Tracker" = "https://github.com/lightfeed/sdk/issues"
3232

3333
[tool.setuptools]
3434
packages = ["lightfeed"]

‎clients/test-clients/test-npm.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Test script for the Lightfeed TypeScript client
22
require("dotenv").config({ path: ".env" });
33

4-
import { LightfeedClient } from "lightfeed";
4+
import { LightfeedClient } from "@lightfeed/sdk";
55

66
// Initialize client with your API key
77
const client = new LightfeedClient({

‎clients/test-clients/test-python.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
import os
55
from dotenv import load_dotenv
6-
from lightfeed import LightfeedClient, Operator
6+
from lightfeed-sdk import LightfeedClient, Operator
77

88
# Load environment variables from .env file
99
load_dotenv()

‎clients/typescript/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ Official Node.js client library for interacting with the Lightfeed API. Extract,
1313
## Installation
1414

1515
```bash
16-
npm install lightfeed
16+
npm install @lightfeed/sdk
1717
```
1818

1919
## Quick Start
2020

2121
```typescript
22-
import { LightfeedClient } from 'lightfeed';
22+
import { LightfeedClient } from '@lightfeed/sdk';
2323

2424
// Initialize client with your API key
2525
const client = new LightfeedClient({
@@ -183,5 +183,5 @@ For comprehensive documentation and guides, visit the [Lightfeed Documentation](
183183

184184
If you need assistance with your implementation:
185185
- Email us at [email protected]
186-
- Open an issue in the [GitHub repository](https://github.com/lightfeed/lightfeed)
186+
- Open an issue in the [GitHub repository](https://github.com/lightfeed/sdk)
187187
- Join our [Discord community](https://discord.gg/txZ2s4pgQJ)

0 commit comments

Comments
 (0)