Skip to content

Update README and change npm and python project names #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-python.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion .github/workflows/release-typescript.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
43 changes: 20 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
<h1 align="center">
<img src="https://www.lightfeed.ai/docs/img/logo.svg" width="32" height="32" alt="Lightfeed Logo"/>
Lightfeed SDK
</h1>

<p align="center">
<img src="https://www.lightfeed.ai/docs/img/logo.svg" width="128" height="128" alt="Lightfeed Logo" />
<strong>Official SDK for real-time search and filtering via the Lightfeed API</strong>
</p>

<div align="center">
<a href="https://www.npmjs.com/package/lightfeed">
<img src="https://img.shields.io/npm/v/lightfeed?logo=npm" alt="npm" /></a>
<a href="https://pypi.org/project/lightfeed/">
<img src="https://img.shields.io/pypi/v/lightfeed?logo=pypi&logoColor=white" alt="PyPI" /></a>
<a href="https://github.com/lightfeed/lightfeed/actions/workflows/ci.yml">
<img src="https://img.shields.io/github/actions/workflow/status/lightfeed/lightfeed/ci.yml?branch=main"
<a href="https://www.npmjs.com/package/@lightfeed/sdk">
<img src="https://img.shields.io/npm/v/@lightfeed/sdk?logo=npm" alt="npm" /></a>
<a href="https://pypi.org/project/lightfeed-sdk/">
<img src="https://img.shields.io/pypi/v/lightfeed-sdk?logo=pypi&logoColor=white" alt="PyPI" /></a>
<a href="https://github.com/lightfeed/sdk/actions/workflows/ci.yml">
<img src="https://img.shields.io/github/actions/workflow/status/lightfeed/sdk/ci.yml?branch=main"
alt="Test status (main branch)"></a>
<a href="https://github.com/lightfeed/lightfeed/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/lightfeed/lightfeed" alt="License" /></a>
<a href="https://github.com/lightfeed/sdk/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/lightfeed/sdk" alt="License" /></a>
</div>
<div>
<p align="center">
Expand All @@ -26,17 +31,9 @@
</p>
</div>

# ⚡️ 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.

<p align="center">
<img src="https://www.lightfeed.ai/docs/img/blog/introducing-lightfeed-extract.png" alt="Lightfeed Extract" width="100%">
</p>

## 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
Expand All @@ -47,21 +44,21 @@ 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

### TypeScript / Node.js

```typescript
import { LightfeedClient } from 'lightfeed';
import { LightfeedClient } from '@lightfeed/sdk';

// Initialize client with your API key
const client = new LightfeedClient({
Expand Down Expand Up @@ -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({
Expand Down Expand Up @@ -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")
Expand Down
6 changes: 3 additions & 3 deletions clients/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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({
Expand Down Expand Up @@ -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")
Expand All @@ -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)
10 changes: 5 additions & 5 deletions clients/python/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"}
Expand All @@ -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"]
Expand Down
2 changes: 1 addition & 1 deletion clients/test-clients/test-npm.js
Original file line number Diff line number Diff line change
@@ -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({
Expand Down
2 changes: 1 addition & 1 deletion clients/test-clients/test-python.py
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
6 changes: 3 additions & 3 deletions clients/typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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({
Expand Down Expand Up @@ -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)
8 changes: 4 additions & 4 deletions clients/typescript/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand All @@ -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": {
Expand Down