Metadata-Version: 2.1
Name: shinden
Version: 0.5
Summary: bs4 web scrapping api for shinden.pl
Home-page: https://github.com/ShaderLight/shinden.py
Author: ShaderLight
License: MIT
Download-URL: https://github.com/ShaderLight/shinden.py/archive/v0.5.tar.gz
Description: # shinden.py  [![Build Status](https://travis-ci.com/ShaderLight/shinden.py.svg?branch=master)](https://travis-ci.com/ShaderLight/shinden.py) ![GitHub](https://img.shields.io/github/license/shaderlight/shinden.py) ![GitHub last commit](https://img.shields.io/github/last-commit/shaderlight/shinden.py) ![PyPI](https://img.shields.io/pypi/v/shinden) 
        bs4 based web scrapping api for shinden.pl
        
        
        ## Required libraries:
        - BeautifulSoup4
        - requests
        - pytest (for testing)
        
        ## Usage
        
        ### Installation
        
        Using pip:
        ```
        pip install shinden
        ```
        
        ### Result
        Results are returned using **Result** object with following attributes:
        - **title**: the title of the series,
        - **tags**: list of tags,
        - **ratings**: dict of specific ratings,
        - **type**: type of series,
        - **episodes**: number of episodes,
        - **status**: status of series (eg. ongoing, finished)
        - **top_score**: overall score
        - **url**: url to the shinden.pl page of the series
        - **cover_url**: url to the cover image
        - **search_url**: url from which the result was extracted
        
        ### Example
        Importing with import alias
        ``` python
        import shinden as sh
        ```
        Generating a list of **Result** objects based on first page of shinden search engine
        ```python
        anime_list = sh.search_titles('alchemist')
        
        #    [a list of Result objects]
        ```
        Getting the title of the first result
        ```python
        anime_list[0].title
        
        #    "Fullmetal Alchemist" 
        ```
        
Keywords: shinden,api,web scrapping
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
