You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+37-32Lines changed: 37 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,8 +3,7 @@
3
3
4
4
<h3align="center">A Python SDK for the Bright Data's Data extraction and Web unlocking tools, providing easy-to-use scalable methods for web scraping, web searches and more.</h3>
5
5
6
-
7
-
For a quick start you can try to run our example files in this repositories under the "Codespace" section.
6
+
For a quick start run this repo's example files "Codespace" section.
8
7
9
8
## Features
10
9
@@ -18,58 +17,37 @@ For a quick start you can try to run our example files in this repositories unde
18
17
19
18
## Installation
20
19
To install the package, open your terminal:
21
-
> [!NOTE]
22
-
> If you are using macOS you will need to open a virtual environment for your project first.
23
20
24
-
```bash
21
+
```python
25
22
pip install brightdata-sdk
23
+
# If using macOS, first open a virtual environment for your project.
26
24
```
27
25
28
26
## Quick Start
29
27
28
+
Create a [Bright Data](https://brightdata.com/) account and copy your API key
29
+
30
30
### 1. Initialize the Client
31
-
> [!IMPORTANT]
32
-
> Go to your [**account settings**](https://brightdata.com/cp/setting/users), to verify that your API key have **"admin permissions"**.
33
31
34
32
```python
35
33
from brightdata import bdclient
36
34
37
35
client = bdclient(api_token="your_api_token_here") # can also be defined as BRIGHTDATA_API_TOKEN in your .env file
38
36
```
39
37
40
-
Or you can use a custom zone name
38
+
Or you can configure a custom zone name
39
+
41
40
```python
42
41
client = bdclient(
43
42
api_token="your_token",
44
43
auto_create_zones=False, # Else it creates the Zone automatically
45
-
web_unlocker_zone="custom_zone",# Custom zone name for web scraping
46
-
serp_zone="custom_serp_zone"# Custom zone name for search requests
44
+
web_unlocker_zone="custom_zone",
45
+
serp_zone="custom_serp_zone"
47
46
)
48
-
```
49
-
> [!TIP]
50
-
> Hover over the "bdclient" (or over each function in the package) with your cursor to see all its available parameters.
0 commit comments