Metadata-Version: 1.2
Name: scylla
Version: 0.2.0
Summary: Intelligent proxy pool for Humans™
Home-page: https://github.com/imWildCat/scylla
Author: WildCat
Author-email: wildcat.name@gmail.com
License: UNKNOWN
Description: 
        Scylla |Build Status| |codecov| |Documentation Status| |PyPI version| |Docker Build Status|
        ===========================================================================================
        
        An intelligent proxy pool for humanities, only supports Python 3.6. Key
        features:
        
        -  Automatic proxy ip crawling and validation
        -  Easy-to-use JSON API
        -  Simple but beautiful web-based user interface (eg. geographical
           distribution of proxies)
        -  Get started with only **1 command** minimally
        -  Straightforward programmable API
        -  (Additional) Headless browser crawling
        
        Get started
        -----------
        
        Install with Docker (highly recommended)
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code:: bash
        
            docker run -it --name scylla wildcat/scylla
        
        Install directly via pip
        ~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code:: bash
        
            pip install scylla
            scylla # Run the cralwer and web server for JSON API
        
        Use from source
        ~~~~~~~~~~~~~~~
        
        .. code:: bash
        
            git clone https://github.com/imWildCat/scylla.git
            cd scylla
        
            pip install -r requirements.txt
        
            npm install # or yarn install
            npm build # or yarn build
        
            python -m scylla
        
        Programmatically
        ~~~~~~~~~~~~~~~~
        
        For more details, please read the `API
        Documentation <http://scylla.wildcat.io/en/latest/py-modindex.html>`__.
        
        Roadmap
        -------
        
        -  [x] Basic RESTFul API
        -  [x] Advanced RESTFul API (Sorting, paging, conditions)
        -  [ ] Programmable API
        -  [x] Docker integration
        -  [ ] Smart web proxy server
        -  [ ] More statistical views of proxies
        -  [ ] Quality statistics for different providers
        -  [x] Over 10 data sources
        
        Development and Contribution
        ----------------------------
        
        .. code:: bash
        
            git clone https://github.com/imWildCat/scylla.git
            cd scylla
        
            pip install -r requirements.txt
        
            npm install # or yarn install
        
        Testing
        -------
        
        .. code:: bash
        
            pip install -r tests/requirements-test.txt
            pytest -n 10 tests
        
        License
        -------
        
        Apache License 2.0. For more details, please read the
        `LICENSE <./LICENSE>`__ file.
        
        .. |Build Status| image:: https://travis-ci.org/imWildCat/scylla.svg?branch=master
           :target: https://travis-ci.org/imWildCat/scylla
        .. |codecov| image:: https://codecov.io/gh/imWildCat/scylla/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/imWildCat/scylla
        .. |Documentation Status| image:: https://readthedocs.org/projects/scylla-py/badge/?version=latest
           :target: https://scylla.wildcat.io/en/latest/?badge=latest
        .. |PyPI version| image:: https://badge.fury.io/py/scylla.svg
           :target: https://badge.fury.io/py/scylla
        .. |Docker Build Status| image:: https://img.shields.io/docker/build/wildcat/scylla.svg
           :target: https://hub.docker.com/r/wildcat/scylla/
        
Keywords: proxy,api,scylla
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.6.0
