This release is a pre-release and may not be stable for production use.
Crawlab SDK for Python
中文 | English
The SDK for Python contains two parts:
- CLI Tool
- Utility Tools
CLI Tool
The CLI Tool is mainly designed for those who are more comfortable using command line tools to interact with Crawlab.
The installation of the CLI Tool is simple:
pip install crawlab-sdk
Then, you can use the crawlab command in the command prompt to action with Crawlab.
Check the help document below, or you can refer to the official documentation (Chinese).
crawlab --help
Utility Tools
Utility tools mainly provide some helper methods to make it easier for you to integrate your spiders into Crawlab, e.g. saving results.
Below are integration methods of Scrapy and general Python spiders with Crawlab.
⚠️Note: make sure you have already installed crawlab-sdk using pip.
Scrapy Integration
In settings.py in your Scrapy project, find the variable named ITEM_PIPELINES (a dict variable). Add content below.
ITEM_PIPELINES = {
'crawlab.pipelines.CrawlabMongoPipeline': 888,
}
Then, start the Scrapy spider. After it's done, you should be able to see scraped results in Task Detail -> Result
General Python Spider Integration
Please add below content to your spider files to save results.
# import result saving method
from crawlab import save_item
# this is a result record, must be dict type
result = {'name': 'crawlab'}
# call result saving method
save_item(result)
Then, start the spider. After it's done, you should be able to see scraped results in Task Detail -> Result
1 maintainer
Metadata
1 maintainer
Release files for crawlab-sdk 0.6.b20211224-1500
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| crawlab-sdk-0.6.b20211224-1500.tar.gz | 19.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| crawlab_sdk-0.6b20211224.post1500-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 63.4 kB
Release files / crawlab-sdk-0.6.b20211224-1500.tar.gz
| Download URL | crawlab-sdk-0.6.b20211224-1500.tar.gz |
|---|---|
| Size | 19.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d322b9b7c750e2ceebb34bda321fb5b9f63c1fb49669e7cc9b59feff81f4e68e
|
|
BLAKE2b-256 checksum How to use checksums |
aec743219c2d8449963bd528ceade435eadb4043f129037db90a6e4bc29f81a9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1
|
Release files / crawlab_sdk-0.6b20211224.post1500-py3-none-any.whl
| Download URL | crawlab_sdk-0.6b20211224.post1500-py3-none-any.whl |
|---|---|
| Size | 44.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6d3c720cc1de68cc5473787bcefa8d52d027e00ad43a305d282b82c69edcc95a
|
|
BLAKE2b-256 checksum How to use checksums |
c426ae51029fdcec5033ca271b0fb73166d494174f9f6f4651df747ae6367d7e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1
|
