Merge branch 'main' of https://github.com/brightdata/bright-data-sdk-python

Author: עידן וילנסקי

README.md

@@ -4,18 +4,21 @@
 ```python
 pip install brightdata-sdk
 ```
-<h3 align="center">Python SDK by Bright Data, providing easy-to-use scalable methods for web search & scraping</h3>
+<h3 align="center">Python SDK by Bright Data, Easy-to-use scalable methods for web search & scraping</h3>
 <p></p>
 
 ## Features
 
-- **Web Scraping**: Scrape websites using Bright Data Web Unlocker API with proxy support
-- **Search Engine Results**: Perform web searches using Bright Data SERP API
-- **Multiple Search Engines**: Support for Google, Bing, and Yandex
-- **Parallel Processing**: Concurrent processing for multiple URLs or queries
-- **Robust Error Handling**: Comprehensive error handling with retry logic
-- **Zone Management**: Automatic zone creation and management
-- **Multiple Output Formats**: JSON, raw HTML, markdown, and more
+| Feature                        | Functions                   | Description
+|--------------------------|-----------------------------|-------------------------------------
+| **Scrape every website** | `scrape`                    | Scrape every website using Bright's scraping and unti bot-detection capabilities
+| **Web search**           | `search`                    | Search google and other search engines by query (supports batch searches)
+| **Search chatGPT**       | `search_chatGPT`            | Prompt chatGPT and scrape its answers, support multiple inputs and follow-up prompts
+| **Search linkedin**      | `search_linkedin.posts()`, `search_linkedin.jobs()`, `search_linkedin.profiles()` | Search LinkedIn by specific queries, and recieve structured data
+| **Scrape linkedin**      | `scrape_linkedin.posts()`, `scrape_linkedin.jobs()`, `scrape_linkedin.profiles()`, `scrape_linkedin.companies()` | Scrape LinkedIn and recieve structured data
+| **Download functions**   | `download_snapshot`, `download_content`  | Download content for both sync and async requests
+| **Client class**         | `bdclient`         | Handles authentication, automatic zone creation and managment, and options for robust error handling
+| **Parallel processing**  | **all functions**  | All functions use Concurrent processing for multiple URLs or queries, and support multiple Output Formats
 
 ## Installation
 To install the package, open your terminal:
@@ -37,70 +40,89 @@ from brightdata import bdclient
 client = bdclient(api_token="your_api_token_here") # can also be defined as BRIGHTDATA_API_TOKEN in your .env file
 ```
 
-Or you can configure a custom zone name
+### 2. Try usig one of the functions
 
+#### `Search()`
 ```python
-client = bdclient(
-    api_token="your_token",
-    auto_create_zones=False,          # Else it creates the Zone automatically
-    web_unlocker_zone="custom_zone",
-    serp_zone="custom_serp_zone"
-)
-
-```
-
-### 2. Search Engine Results
-
-```python
-# Single search query
+# Simple single query search
 result = client.search("pizza restaurants")
 
-# Multiple queries (parallel processing)
+# Try using multiple queries (parallel processing), with custom configuration
 queries = ["pizza", "restaurants", "delivery"]
-results = client.search(queries)
-
-# Different search engines
-result = client.search("pizza", search_engine="google") # search_engine can also be set to "yandex" or "bing"
-
-# Custom options
 results = client.search(
-    ["pizza", "sushi"],
+    queries,
+    search_engine="bing",
     country="gb",
     format="raw"
 )
 ```
-
-> [!TIP]
-> Hover over the "search" or each function in the package, to see all its available parameters.
-
-![Hover-Over1](https://github.com/user-attachments/assets/51324485-5769-48d5-8f13-0b534385142e)
-
-### 3. Scrape Websites
-
+#### `scrape()`
 ```python
-# Single URL
+# Simple single URL scrape
 result = client.scrape("https://example.com")
 
-# Multiple URLs (parallel processing)
+# Multiple URLs (parallel processing) with custom options
 urls = ["https://example1.com", "https://example2.com", "https://example3.com"]
-results = client.scrape(urls)
-
-# Custom options
-result = client.scrape(
-    "https://example.com",
+results = client.scrape(
+    "urls",
     format="raw",
     country="gb",
     data_format="screenshot"
 )
 ```
+#### `search_chatGPT()`
+```python
+result = client.search_chatGPT(
+    prompt="what day is it today?"
+    # prompt=["What are the top 3 programming languages in 2024?", "Best hotels in New York", "Explain quantum computing"],
+    # additional_prompt=["Can you explain why?", "Are you sure?", ""]  
+)
+
+client.download_content(result) # In case of timeout error, your snapshot_id is presented and you will downloaded it using download_snapshot()
+```
+
+#### `search_linkedin.`
+Available functions:
+client.**`search_linkedin.posts()`**,client.**`search_linkedin.jobs()`**,client.**`search_linkedin.profiles()`**
+```python
+# Search LinkedIn profiles by name
+first_names = ["James", "Idan"]
+last_names = ["Smith", "Vilenski"]
+
+result = client.search_linkedin.profiles(first_names, last_names) # can also be changed to async
+# will print the snapshot_id, which can be downloaded using the download_snapshot() function
+```
 
-### 4. Download Content
+#### `scrape_linkedin.`
+Available functions
 
+client.**`scrape_linkedin.posts()`**,client.**`scrape_linkedin.jobs()`**,client.**`scrape_linkedin.profiles()`**,client.**`scrape_linkedin.companies()`**
+```python
+post_urls = [
+    "https://www.linkedin.com/posts/orlenchner_scrapecon-activity-7180537307521769472-oSYN?trk=public_profile",
+    "https://www.linkedin.com/pulse/getting-value-out-sunburst-guillaume-de-b%C3%A9naz%C3%A9?trk=public_profile_article_view"
+]
+
+results = client.scrape_linkedin.posts(post_urls) # can also be changed to async
+
+print(results) # will print the snapshot_id, which can be downloaded using the download_snapshot() function
+```
+
+**`download_content`** (for sync requests)
 ```python
-# Download scraped content
 data = client.scrape("https://example.com")
 client.download_content(data) 
 ```
+**`download_snapshot`** (for async requests)
+```python
+# Save this function to seperate file
+client.download_snapshot("") # Insert your snapshot_id
+```
+
+> [!TIP]
+> Hover over the "search" or each function in the package, to see all its available parameters.
+
+![Hover-Over1](https://github.com/user-attachments/assets/51324485-5769-48d5-8f13-0b534385142e)
 
 ## Function Parameters
 <details>
@@ -185,6 +207,18 @@ zones = client.list_zones()
 print(f"Found {len(zones)} zones")
 ```
 
+Configure a custom zone name
+
+```python
+client = bdclient(
+    api_token="your_token",
+    auto_create_zones=False,          # Else it creates the Zone automatically
+    web_unlocker_zone="custom_zone",
+    serp_zone="custom_serp_zone"
+)
+
+```
+
 </details>
 <details>
     <summary>👥 <strong>Client Management</strong></summary>