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.b20210729-1625

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.b20210729-1625
File Size Uploaded
crawlab-sdk-0.6.b20210729-1625.tar.gz 7.4 kB Details

Built distribution (wheel)

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

Total release size: 16.8 kB

Release files / crawlab-sdk-0.6.b20210729-1625.tar.gz

Download URL crawlab-sdk-0.6.b20210729-1625.tar.gz
Size 7.4 kB
Tags Source
SHA-256 checksum
How to use checksums
447e6b4904001a7e9fe937dec813395d94f6c760bb68d03ceaa1eb3815ee9f25
BLAKE2b-256 checksum
How to use checksums
31e84cafcd20205eeb4ac7e3d5ecf211c9a2c73a8d80c9b56912093f54fc8311
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

Release files / crawlab_sdk-0.6b20210729.post1625-py3-none-any.whl

Download URL crawlab_sdk-0.6b20210729.post1625-py3-none-any.whl
Size 9.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6704175004221f23e246727f200c0f1c2938deb2b23bb45d56b4215f825ed095
BLAKE2b-256 checksum
How to use checksums
efb957538842920a3b9c3c063642fe2f3f3307b6f831c0af90b5fde8084a2a4a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

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