Metadata-Version: 2.1
Name: crawlab-sdk
Version: 0.6.0.post2
Summary: Python SDK for Crawlab
Home-page: https://github.com/crawlab-team/crawlab-sdk
Author: tikazyq
Author-email: tikazyq@163.com
License: BSD-3-Clause
Description: # Crawlab SDK for Python
        
        [中文](https://github.com/crawlab-team/crawlab-sdk/blob/master/python/README-zh.md) | 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:
        
        ```bash
        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)](https://docs.crawlab.cn/SDK/CLI.html). 
        
        ```
        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.
        
        ```python
        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.
        
        ```python
        # 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**
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
