Skip to main content
Pre-release

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:

  1. CLI Tool
  2. 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

Metadata

Release files for crawlab-sdk 0.6.b20211024-1207

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for crawlab-sdk 0.6.b20211024-1207
File Size Uploaded
crawlab-sdk-0.6.b20211024-1207.tar.gz 15.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for crawlab-sdk 0.6.b20211024-1207
File Interpreter ABI Platform
crawlab_sdk-0.6b20211024.post1207-py3-none-any.whl Python 3 none any Details

Total release size: 53.3 kB

Release files / crawlab-sdk-0.6.b20211024-1207.tar.gz

Download URL crawlab-sdk-0.6.b20211024-1207.tar.gz
Size 15.5 kB
Tags Source
SHA-256 checksum
How to use checksums
f68ffa71e108e5a5d473b144cd9e7cb1bbae22b56a31f2f4c45c646577d6147c
BLAKE2b-256 checksum
How to use checksums
e8a309b39c14fc6e263dc0d9068a412902544dae2902cb2773a3579a1b9591ea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

Release files / crawlab_sdk-0.6b20211024.post1207-py3-none-any.whl

Download URL crawlab_sdk-0.6b20211024.post1207-py3-none-any.whl
Size 37.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3411d717b6f2aa65f75aadb0a84df1a259047002e1f4e6738d961b2fefe67a78
BLAKE2b-256 checksum
How to use checksums
bd43ba65b699e23908b4f5a9451bdb2649cc738521adca3f50af07b15d3c5e4c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

Release history Release notifications | RSS feed

0.7.0

2 release files

0.6.2

2 release files

0.6.0

2 release files

This release

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.5

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page