1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
|
%global _empty_manifest_terminate_build 0
Name: python-comcrawl
Version: 1.0.2
Release: 1
Summary: A python utility for downloading Common Crawl data.
License: MIT
URL: https://github.com/michaelharms/comcrawl
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/7c/46/0c519595db0a5e217ab43b0755f7d8d3be305e0da98caee31df0454d20b5/comcrawl-1.0.2.tar.gz
BuildArch: noarch
Requires: python3-requests
%description
# comcrawl
[](https://codecov.io/gh/michaelharms/comcrawl)
_comcrawl_ is a python package for easily querying and downloading pages from [commoncrawl.org](https://commoncrawl.org).
## Introduction
I was inspired to make _comcrawl_ by reading this [article](https://www.bellingcat.com/resources/2015/08/13/using-python-to-mine-common-crawl/).
**Note:** I made this for personal projects and for fun. Thus this package is intended for use in small to medium projects, because it is not optimized for handling gigabytes or terrabytes of data. You might want to check out [cdx-toolkit](https://pypi.org/project/cdx-toolkit/) or [cdx-index-client](https://github.com/ikreymer/cdx-index-client) in such cases.
### What is Common Crawl?
The Common Crawl project is an _"open repository of web crawl data that can be accessed and analyzed by anyone"_.
It contains billions of web pages and is often used for NLP projects to gather large amounts of text data.
Common Crawl provides a [search index](https://index.commoncrawl.org), which you can use to search for certain URLs in their crawled data.
Each search result contains a link and byte offset to a specific location in their [AWS S3 buckets](https://commoncrawl.s3.amazonaws.com/cc-index/collections/index.html) to download the page.
### What does _comcrawl_ offer?
_comcrawl_ simplifies this process of searching and downloading from Common Crawl by offering a simple API interface you can use in your python program.
## Installation
_comcrawl_ is available on PyPI.
Install it via pip by running the following command from your terminal:
```
pip install comcrawl
```
## Usage
### Basic
The HTML for each page will be available as a string in the 'html' key in each results dictionary after calling the `download` method.
```python
from comcrawl import IndexClient
client = IndexClient()
client.search("reddit.com/r/MachineLearning/*")
client.download()
first_page_html = client.results[0]["html"]
```
### Multithreading
You can leverage multithreading while searching or downloading by specifying the number of threads you want to use.
Please keep in mind to not overdo this, so you don't put too much stress on the Common Crawl servers (have a look at [Code of Conduct](#code-of-conduct)).
```python
from comcrawl import IndexClient
client = IndexClient()
client.search("reddit.com/r/MachineLearning/*", threads=4)
client.download(threads=4)
```
### Removing duplicates & Saving
You can easily combine this package with the [pandas](https://github.com/pandas-dev/pandas) library, to filter out duplicate results and persist them to disk:
```python
from comcrawl import IndexClient
import pandas as pd
client = IndexClient()
client.search("reddit.com/r/MachineLearning/*")
client.results = (pd.DataFrame(client.results)
.sort_values(by="timestamp")
.drop_duplicates("urlkey", keep="last")
.to_dict("records"))
client.download()
pd.DataFrame(client.results).to_csv("results.csv")
```
The urlkey alone might not be sufficient here, so you might want to write a function to compute a custom id from the results' properties for the removal of duplicates.
### Searching subsets of Indexes
By default, when instantiated, the `IndexClient` fetches a list of currently available Common Crawl indexes to search. You can also restrict the search to certain Common Crawl Indexes, by specifying them as a list.
```python
from comcrawl import IndexClient
client = IndexClient(["2019-51", "2019-47"])
client.search("reddit.com/r/MachineLearning/*")
client.download()
```
### Logging HTTP requests
When debugging your code, you can enable logging of all HTTP requests that are made.
```python
from comcrawl import IndexClient
client = IndexClient(verbose=True)
client.search("reddit.com/r/MachineLearning/*")
client.download()
```
## Code of Conduct
When accessing Common Crawl, please beware these guidelines posted by one of the Common Crawl maintainers:
https://groups.google.com/forum/#!msg/common-crawl/3QmQjFA_3y4/vTbhGqIBBQAJ
%package -n python3-comcrawl
Summary: A python utility for downloading Common Crawl data.
Provides: python-comcrawl
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-comcrawl
# comcrawl
[](https://codecov.io/gh/michaelharms/comcrawl)
_comcrawl_ is a python package for easily querying and downloading pages from [commoncrawl.org](https://commoncrawl.org).
## Introduction
I was inspired to make _comcrawl_ by reading this [article](https://www.bellingcat.com/resources/2015/08/13/using-python-to-mine-common-crawl/).
**Note:** I made this for personal projects and for fun. Thus this package is intended for use in small to medium projects, because it is not optimized for handling gigabytes or terrabytes of data. You might want to check out [cdx-toolkit](https://pypi.org/project/cdx-toolkit/) or [cdx-index-client](https://github.com/ikreymer/cdx-index-client) in such cases.
### What is Common Crawl?
The Common Crawl project is an _"open repository of web crawl data that can be accessed and analyzed by anyone"_.
It contains billions of web pages and is often used for NLP projects to gather large amounts of text data.
Common Crawl provides a [search index](https://index.commoncrawl.org), which you can use to search for certain URLs in their crawled data.
Each search result contains a link and byte offset to a specific location in their [AWS S3 buckets](https://commoncrawl.s3.amazonaws.com/cc-index/collections/index.html) to download the page.
### What does _comcrawl_ offer?
_comcrawl_ simplifies this process of searching and downloading from Common Crawl by offering a simple API interface you can use in your python program.
## Installation
_comcrawl_ is available on PyPI.
Install it via pip by running the following command from your terminal:
```
pip install comcrawl
```
## Usage
### Basic
The HTML for each page will be available as a string in the 'html' key in each results dictionary after calling the `download` method.
```python
from comcrawl import IndexClient
client = IndexClient()
client.search("reddit.com/r/MachineLearning/*")
client.download()
first_page_html = client.results[0]["html"]
```
### Multithreading
You can leverage multithreading while searching or downloading by specifying the number of threads you want to use.
Please keep in mind to not overdo this, so you don't put too much stress on the Common Crawl servers (have a look at [Code of Conduct](#code-of-conduct)).
```python
from comcrawl import IndexClient
client = IndexClient()
client.search("reddit.com/r/MachineLearning/*", threads=4)
client.download(threads=4)
```
### Removing duplicates & Saving
You can easily combine this package with the [pandas](https://github.com/pandas-dev/pandas) library, to filter out duplicate results and persist them to disk:
```python
from comcrawl import IndexClient
import pandas as pd
client = IndexClient()
client.search("reddit.com/r/MachineLearning/*")
client.results = (pd.DataFrame(client.results)
.sort_values(by="timestamp")
.drop_duplicates("urlkey", keep="last")
.to_dict("records"))
client.download()
pd.DataFrame(client.results).to_csv("results.csv")
```
The urlkey alone might not be sufficient here, so you might want to write a function to compute a custom id from the results' properties for the removal of duplicates.
### Searching subsets of Indexes
By default, when instantiated, the `IndexClient` fetches a list of currently available Common Crawl indexes to search. You can also restrict the search to certain Common Crawl Indexes, by specifying them as a list.
```python
from comcrawl import IndexClient
client = IndexClient(["2019-51", "2019-47"])
client.search("reddit.com/r/MachineLearning/*")
client.download()
```
### Logging HTTP requests
When debugging your code, you can enable logging of all HTTP requests that are made.
```python
from comcrawl import IndexClient
client = IndexClient(verbose=True)
client.search("reddit.com/r/MachineLearning/*")
client.download()
```
## Code of Conduct
When accessing Common Crawl, please beware these guidelines posted by one of the Common Crawl maintainers:
https://groups.google.com/forum/#!msg/common-crawl/3QmQjFA_3y4/vTbhGqIBBQAJ
%package help
Summary: Development documents and examples for comcrawl
Provides: python3-comcrawl-doc
%description help
# comcrawl
[](https://codecov.io/gh/michaelharms/comcrawl)
_comcrawl_ is a python package for easily querying and downloading pages from [commoncrawl.org](https://commoncrawl.org).
## Introduction
I was inspired to make _comcrawl_ by reading this [article](https://www.bellingcat.com/resources/2015/08/13/using-python-to-mine-common-crawl/).
**Note:** I made this for personal projects and for fun. Thus this package is intended for use in small to medium projects, because it is not optimized for handling gigabytes or terrabytes of data. You might want to check out [cdx-toolkit](https://pypi.org/project/cdx-toolkit/) or [cdx-index-client](https://github.com/ikreymer/cdx-index-client) in such cases.
### What is Common Crawl?
The Common Crawl project is an _"open repository of web crawl data that can be accessed and analyzed by anyone"_.
It contains billions of web pages and is often used for NLP projects to gather large amounts of text data.
Common Crawl provides a [search index](https://index.commoncrawl.org), which you can use to search for certain URLs in their crawled data.
Each search result contains a link and byte offset to a specific location in their [AWS S3 buckets](https://commoncrawl.s3.amazonaws.com/cc-index/collections/index.html) to download the page.
### What does _comcrawl_ offer?
_comcrawl_ simplifies this process of searching and downloading from Common Crawl by offering a simple API interface you can use in your python program.
## Installation
_comcrawl_ is available on PyPI.
Install it via pip by running the following command from your terminal:
```
pip install comcrawl
```
## Usage
### Basic
The HTML for each page will be available as a string in the 'html' key in each results dictionary after calling the `download` method.
```python
from comcrawl import IndexClient
client = IndexClient()
client.search("reddit.com/r/MachineLearning/*")
client.download()
first_page_html = client.results[0]["html"]
```
### Multithreading
You can leverage multithreading while searching or downloading by specifying the number of threads you want to use.
Please keep in mind to not overdo this, so you don't put too much stress on the Common Crawl servers (have a look at [Code of Conduct](#code-of-conduct)).
```python
from comcrawl import IndexClient
client = IndexClient()
client.search("reddit.com/r/MachineLearning/*", threads=4)
client.download(threads=4)
```
### Removing duplicates & Saving
You can easily combine this package with the [pandas](https://github.com/pandas-dev/pandas) library, to filter out duplicate results and persist them to disk:
```python
from comcrawl import IndexClient
import pandas as pd
client = IndexClient()
client.search("reddit.com/r/MachineLearning/*")
client.results = (pd.DataFrame(client.results)
.sort_values(by="timestamp")
.drop_duplicates("urlkey", keep="last")
.to_dict("records"))
client.download()
pd.DataFrame(client.results).to_csv("results.csv")
```
The urlkey alone might not be sufficient here, so you might want to write a function to compute a custom id from the results' properties for the removal of duplicates.
### Searching subsets of Indexes
By default, when instantiated, the `IndexClient` fetches a list of currently available Common Crawl indexes to search. You can also restrict the search to certain Common Crawl Indexes, by specifying them as a list.
```python
from comcrawl import IndexClient
client = IndexClient(["2019-51", "2019-47"])
client.search("reddit.com/r/MachineLearning/*")
client.download()
```
### Logging HTTP requests
When debugging your code, you can enable logging of all HTTP requests that are made.
```python
from comcrawl import IndexClient
client = IndexClient(verbose=True)
client.search("reddit.com/r/MachineLearning/*")
client.download()
```
## Code of Conduct
When accessing Common Crawl, please beware these guidelines posted by one of the Common Crawl maintainers:
https://groups.google.com/forum/#!msg/common-crawl/3QmQjFA_3y4/vTbhGqIBBQAJ
%prep
%autosetup -n comcrawl-1.0.2
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-comcrawl -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 1.0.2-1
- Package Spec generated
|
