Metadata-Version: 2.1
Name: hemnes
Version: 0.1.8
Summary: An in-depth ikea scraper
Home-page: https://github.com/sayeefrmoyen/hemnes
Author: Sayeef Moyen
Author-email: develop.sayeefrm@gmail.com
License: UNKNOWN
Description: <!-- HEADER INFORMATION -->
        <h3 align="center">HEMNES</h3>
        
        <p align="center">
            <strong><em>A plug-and-play python3 ikea scraping package</em></strong>
            <br />
            <a href="https://sayeefrmoyen.github.io/hemnes/deploy/html/index.html"><strong>Explore the docs »</strong></a>
            <br />
            <br />
            <a href="https://github.com/sayeefrmoyen/hemnes/issues">Report Bug</a>
            ·
            <a href="https://github.com/sayeefrmoyen/hemnes/issues">Request Feature</a>
          </p>
        </p>
        
        <!-- TABLE OF CONTENTS -->
        ## Table of Contents
        
        * [About the Project](#about-the-project)
          * [Built With](#built-with)
        * [Getting Started](#getting-started)
          * [Installation](#installation)
        * [Usage](#usage)
        * [License](#license)
        * [Contact](#contact)
        * [Release History](#release-history)
        * [Acknowledgments](#acknowledgments)
        
        <!-- ABOUT THE PROJECT -->
        ## About The Project
        
        Hemnes is a simple python3 package for scraping data from Ikea. Hemnes supports multi-word & strict
        queries, as well as saving data to json. The following data is scraped by Hemnes for each matching
        product found:
        
        * `name (str)`
        * `price (float)`
        * `rank (int)`: based on order that products are returned for the query
        * `rating (float)`: average user rating
        * `url (str)`: product url
        * `color (list[str])`: list of colors as strings of the product
        * `images (list[str])`: list of full urls to product images
        
        ### Built With
        Powered by:
        * [BeautifulSoup](https://www.crummy.com/software/BeautifulSoup/)
        * [ChromeDriver](http://chromedriver.chromium.org/getting-started)
        * [Selenium](https://www.seleniumhq.org)
        
        <!-- GETTING STARTED -->
        ## Getting Started
        
        Hemnes is distributed as a pip package. It can be an installed using standard pip installation:
        ```sh
        pip install hemnes
        ```
        
        Import Hemnes into your python scripts:
        ```python
        import hemnes
        ```
        
        ### Prerequisites
        
        Hemnes requires **python3** and **pip3**
        
        <!-- USAGE EXAMPLES -->
        ## Usage
        
        Hemnes makes it easy to get detailed product data from Ikea
        
        For retrieving product results as a list to then process yourself simply call:
        ```python
        product_results = get_products("coffee table")
        ```
        
        `product_results` will now contain a `list[Product]`
        
        `Product` is a simple helper class which contains the following fields:
        
        * `name (str)`
        * `tag (str)`
        * `price (float)`
        * `rank (int)`: based on order that products are returned for the query
        * `rating (float)`: average user rating
        * `url (str)`: product url
        * `color (list[str])`: list of colors as strings of the product
        * `images (list[str])`: list of full urls to product images
        	
        `tag` is a meta-field that can be used flexibly. By default tag is set to `None`. Some example usages of tag may be:
        
              * Keeping track of which batch each item was stored
              * For use as a key in databases
        
        If you would like to save the results to a json file you can add the `data_path` param:
        ```python
        # saving results to json
        product_results = get_products("coffee table", data_path="data/coffeetable.json")
        ```
        
        Hemnes supports "strict searching" to specify required descriptive keywords for returned results. To use this add a `keywords` param:
        ```python
        # adding required keywords
        product_results = get_products("coffee table", keywords=["large", "wooden"])
        ```
        
        Hemnes will look for the given keywords in each product's detailed description, and only return those products which contain
        all of the given keywords.
        
        To include a `tag` in the returned results simply pass it to the call:
        ```python
        # including a tag
        product_results = get_products("coffee table", tag="tables")
        ```
        
        _For more examples, please refer to the [Documentation](https://sayeefrmoyen.github.io/hemnes/deploy/html/index.html)_
        
        <!-- LICENSE -->
        ## License
        
        Distributed under the MIT License. See `LICENSE` for more information.
        
        <!-- CONTACT -->
        ## Contact
        
        Sayeef Moyen - develop.sayeefrm@gmail.com
        Project Link: [https://github.com/sayeefrmoyen/hemnes](https://github.com/sayeefrmoyen/hemnes)
        
        <!-- Release History -->
        ## Release History
        Release History
        
        * 0.1.5
        	* Fix packaging bugs
        * 0.1.0
        	* First proper release
        	* Documentation still **incomplete**
        	* Price-based querying functionality implemented, but not yet made available
        
        <!-- Acknowledgments -->
        ## Acknowledgments
        
        * [Awesome README template](https://github.com/othneildrew/Best-README-Template/blob/master/README.md)
Keywords: scraping ikea ikea-scraping python3 beautifulsoup,beautiful-soup
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown
