Skip to content

Commit 762ab54

Browse files
lexiforestlexiforest
committed
Update docs
1 parent 150011e commit 762ab54

File tree

6 files changed

+36
-37
lines changed

6 files changed

+36
-37
lines changed

‎README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -96,10 +96,10 @@ To install unstable version from GitHub:
9696
### requests-like
9797

9898
```python
99-
from curl_cffi import requests
99+
import curl_cffi
100100

101101
# Notice the impersonate parameter
102-
r = requests.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome")
102+
r = curl_cffi.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome")
103103

104104
print(r.json())
105105
# output: {..., "ja3n_hash": "aa56c057ad164ec4fdcb7a5a283be9fc", ...}
@@ -108,27 +108,27 @@ print(r.json())
108108
# To keep using the latest browser version as `curl_cffi` updates,
109109
# simply set impersonate="chrome" without specifying a version.
110110
# Other similar values are: "safari" and "safari_ios"
111-
r = requests.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome")
111+
r = curl_cffi.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome")
112112

113113
# To pin a specific version, use version numbers together.
114-
r = requests.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome124")
114+
r = curl_cffi.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome124")
115115

116116
# To impersonate other than browsers, bring your own ja3/akamai strings
117117
# See examples directory for details.
118-
r = requests.get("https://tls.browserleaks.com/json", ja3=..., akamai=...)
118+
r = curl_cffi.get("https://tls.browserleaks.com/json", ja3=..., akamai=...)
119119

120120
# http/socks proxies are supported
121121
proxies = {"https": "http://localhost:3128"}
122-
r = requests.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome", proxies=proxies)
122+
r = curl_cffi.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome", proxies=proxies)
123123

124124
proxies = {"https": "socks://localhost:3128"}
125-
r = requests.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome", proxies=proxies)
125+
r = curl_cffi.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome", proxies=proxies)
126126
```
127127

128128
### Sessions
129129

130130
```python
131-
s = requests.Session()
131+
s = curl_cffi.Session()
132132

133133
# httpbin is a http test website, this endpoint makes the server set cookies
134134
s.get("https://httpbin.org/cookies/set/foo/bar")
@@ -183,7 +183,7 @@ Notes:
183183
### asyncio
184184

185185
```python
186-
from curl_cffi.requests import AsyncSession
186+
from curl_cffi import AsyncSession
187187

188188
async with AsyncSession() as s:
189189
r = await s.get("https://example.com")
@@ -193,7 +193,7 @@ More concurrency:
193193

194194
```python
195195
import asyncio
196-
from curl_cffi.requests import AsyncSession
196+
from curl_cffi import AsyncSession
197197

198198
urls = [
199199
"https://google.com/",
@@ -212,7 +212,7 @@ async with AsyncSession() as s:
212212
### WebSockets
213213

214214
```python
215-
from curl_cffi.requests import WebSocket
215+
from curl_cffi import WebSocket
216216

217217
def on_message(ws: WebSocket, message: str | bytes):
218218
print(message)
@@ -228,7 +228,7 @@ For low-level APIs, Scrapy integration and other advanced topics, see the
228228

229229
```python
230230
import asyncio
231-
from curl_cffi.requests import AsyncSession
231+
from curl_cffi import AsyncSession
232232

233233
async with AsyncSession() as s:
234234
ws = await s.ws_connect("wss://echo.websocket.org")

‎curl_cffi/__init__.py

-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
"patch",
2525
"delete",
2626
"options",
27-
"RequestsError",
2827
"Cookies",
2928
"Headers",
3029
"Request",
@@ -71,7 +70,6 @@
7170
HeaderTypes,
7271
ProxySpec,
7372
Request,
74-
RequestsError,
7573
Response,
7674
Session,
7775
WebSocket,

‎docs/cookies.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Using pickle:
1414
# example from: https://github.com/encode/httpx/issues/895
1515
import pickle
1616
# import httpx
17-
from curl_cffi import requests
17+
import curl_cffi
1818
1919
def save_cookies(client):
2020
with open("cookies.pk", "wb") as f:
@@ -27,11 +27,11 @@ Using pickle:
2727
return pickle.load(f)
2828
2929
# client = httpx.Client(cookies=load_cookies())
30-
client = requests.Session()
30+
client = curl_cffi.Session()
3131
client.get("https://httpbin.org/cookies/set/foo/bar")
3232
save_cookies(client)
3333
34-
client = requests.Session()
34+
client = curl_cffi.Session()
3535
client.cookies.jar._cookies.update(load_cookies())
3636
print(client.cookies.get("foo"))
3737

‎docs/faq.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The simplest way is to turn off cert verification by ``verify=False``:
5050

5151
.. code-block:: python
5252
53-
r = requests.get("https://example.com", verify=False)
53+
r = curl_cffi.get("https://example.com", verify=False)
5454
5555
5656
ErrCode: 77, Reason: error setting certificate verify locations
@@ -89,9 +89,9 @@ To force curl to use http 1.1 only.
8989

9090
.. code-block:: python
9191
92-
from curl_cffi import requests, CurlHttpVersion
92+
import curl_cffi
9393
94-
r = requests.get("https://postman-echo.com", http_version=CurlHttpVersion.V1_1)
94+
r = curl_cffi.get("https://postman-echo.com", http_version=curl_cffi.CurlHttpVersion.V1_1)
9595
9696
Related issues:
9797

@@ -136,9 +136,9 @@ You can use the ``proxy`` parameter:
136136

137137
.. code-block:: python
138138
139-
from curl_cffi import requests
139+
import curl_cffi
140140
141-
requests.get(url, proxy="http://user:[email protected]:3128")
141+
curl_cffi.get(url, proxy="http://user:[email protected]:3128")
142142
143143
You can also use the ``http_proxy``, ``https_proxy``, and ``ws_proxy``, ``wss_proxy``
144144
environment variables, respectively.
@@ -165,8 +165,8 @@ Use ``chardet`` or ``cchardet``
165165

166166
.. code-block::
167167
168-
>>> from curl_cffi import requests
169-
>>> r = requests.get("https://example.com/messy_codec.html")
168+
>>> import curl_cffi
169+
>>> r = curl_cffi.get("https://example.com/messy_codec.html")
170170
>>> import chardet
171171
>>> chardet.detect(r.content)
172172
{'encoding': 'GB2312', 'confidence': 0.99, 'language': 'Chinese'}

‎docs/impersonate.rst

+6-5
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ browser versions, you can simply use ``chrome``, ``safari`` and ``safari_ios``.
5353

5454
.. code-block:: python
5555
56-
from curl_cffi import requests
56+
import curl_cffi
5757
58-
requests.get(url, impersonate="chrome")
58+
curl_cffi.get(url, impersonate="chrome")
5959
6060
iOS has restrictions on WebView and TLS libs, so ``safari_x_ios`` should work for most apps.
6161
If you encountered an android app with custom fingerprints, you can try the ``safari_ios``
@@ -112,7 +112,7 @@ You can retrieve the JA3 and Akamai strings using tools like WireShark or from T
112112
}
113113
114114
115-
r = requests.get(
115+
r = curl_cffi.get(
116116
url, ja3=okhttp4_android10_ja3, akamai=okhttp4_android10_akamai, extra_fp=extra_fp
117117
)
118118
print(r.json())
@@ -123,13 +123,14 @@ To modify them, use ``curl.setopt(CurlOpt, value)``, for example:
123123

124124
.. code-block:: python
125125
126-
from curl_cffi import Curl, CurlOpt, requests
126+
import curl_cffi
127+
from curl_cffi import Curl, CurlOpt
127128
128129
c = Curl()
129130
c.setopt(CurlOpt.HTTP2_PSEUDO_HEADERS_ORDER, "masp")
130131
131132
# or
132-
requests.get(url, curl_options={CurlOpt.HTTP2_PSEUDO_HEADERS_ORDER, "masp"})
133+
curl_cffi.get(url, curl_options={CurlOpt.HTTP2_PSEUDO_HEADERS_ORDER, "masp"})
133134
134135
Here are a list of options:
135136

‎docs/index.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -128,12 +128,12 @@ requests-like
128128

129129
.. code-block:: python
130130
131-
from curl_cffi import requests
131+
import curl_cffi
132132
133133
url = "https://tools.scrapfly.io/api/fp/ja3"
134134
135135
# Notice the impersonate parameter
136-
r = requests.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome110")
136+
r = curl_cffi.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome110")
137137
138138
print(r.json())
139139
# output: {..., "ja3n_hash": "aa56c057ad164ec4fdcb7a5a283be9fc", ...}
@@ -142,14 +142,14 @@ requests-like
142142
# To keep using the latest browser version as `curl_cffi` updates,
143143
# simply set impersonate="chrome" without specifying a version.
144144
# Other similar values are: "safari" and "safari_ios"
145-
r = requests.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome")
145+
r = curl_cffi.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome")
146146
147147
# http/socks proxies are supported
148148
proxies = {"https": "http://localhost:3128"}
149-
r = requests.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome110", proxies=proxies)
149+
r = curl_cffi.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome110", proxies=proxies)
150150
151151
proxies = {"https": "socks://localhost:3128"}
152-
r = requests.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome110", proxies=proxies)
152+
r = curl_cffi.get("https://tools.scrapfly.io/api/fp/ja3", impersonate="chrome110", proxies=proxies)
153153
154154
Sessions
155155
~~~~~~
@@ -173,7 +173,7 @@ asyncio
173173

174174
.. code-block:: python
175175
176-
from curl_cffi.requests import AsyncSession
176+
from curl_cffi import AsyncSession
177177
178178
async with AsyncSession() as s:
179179
r = await s.get("https://example.com")
@@ -183,7 +183,7 @@ More concurrency:
183183
.. code-block:: python
184184
185185
import asyncio
186-
from curl_cffi.requests import AsyncSession
186+
from curl_cffi import AsyncSession
187187
188188
urls = [
189189
"https://google.com/",
@@ -203,7 +203,7 @@ WebSockets
203203

204204
.. code-block:: python
205205
206-
from curl_cffi.requests import Session, WebSocket
206+
from curl_cffi import Session, WebSocket
207207
208208
def on_message(ws: WebSocket, message):
209209
print(message)

0 commit comments

Comments
 (0)