Skip to main content

Python SDK for Crawlab

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crawlab-sdk-0.6.b20210725-1917.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file crawlab-sdk-0.6.b20210725-1917.tar.gz.

File metadata

  • Download URL: crawlab-sdk-0.6.b20210725-1917.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for crawlab-sdk-0.6.b20210725-1917.tar.gz
Algorithm Hash digest
SHA256 df787cf1ebf8df8e5e052c1beaff23f30717f71e2dc076c69c9e00d7b782f875
MD5 1959d841660dafc0ccd46c876684256a
BLAKE2b-256 3ecfbeb95350ed431a34341550a69f06da202b289563d75df28779eb436502e6

See more details on using hashes here.

File details

Details for the file crawlab_sdk-0.6b20210725.post1917-py3-none-any.whl.

File metadata

  • Download URL: crawlab_sdk-0.6b20210725.post1917-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using 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

File hashes

Hashes for crawlab_sdk-0.6b20210725.post1917-py3-none-any.whl
Algorithm Hash digest
SHA256 905e85def700a764f3eef5c421fd45308b69403d5cb62dfc53d85e2b8daef720
MD5 69aa3e6dd1d939857987e0805bf3e65d
BLAKE2b-256 e76ee2108847dec394ebc501b09cad1c04636654ecc3e9dc1e30c33c5aa38dfb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page