Metadata-Version: 2.1
Name: kupiapi
Version: 1.0.10
Summary: Scraper API for extracting product data from kupi.cz
Home-page: https://github.com/vorava/kupiapi
Author: Vojtech Orava
Author-email: vojtech.orava@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

# Kupi API

This is a lightweight *www.kupi.cz* web scraper for scraping **sales** and **recipes** into JSON. It does require only bs4, json and requests libraries. API provides multiple methods to download content from the kupi website (see more below).

There are two main parts (classes). **KupiScraper** for scraping data about sales and **KupiRecipes** for downloading recipes that are published on kupi.cz.

## Instalation
> pip install kupiapi

PyPi page: [https://pypi.org/project/kupiapi/](https://pypi.org/project/kupiapi/)

GitHub page: [https://github.com/vorava/kupiapi](https://github.com/vorava/kupiapi)

## Usage
    import kupiapi.scraper # imports KupiScraper() class
    import kupiapi.recipes # imports KupiRecipes() class
    

## Methods - Kupi scraper
All methods return JSON formated data if not declared elsewise.

> get_discounts_by_category(category)

Takes name of category to get discounts for. Discounts are scraped from url kupi.cz/slevy/**category**


> get_discounts_by_search(search)

> get_discounts_by_shop(shop)

> get_discounts_by_category_shop(category, shop)



## Methods - Kupi repices
> get_recipes_by_category(category, full=False):

> get_all_recipes(full=False):

> get_recipe_by_search(search, full=False)

> get_categories()





## Examples
    import kupiapi.recipes
    kr = kupiapi.recipes.KupiRecipes()
    
    print(kr.get_categories())
