Metadata-Version: 2.1
Name: finscraper
Version: 0.2.2
Summary: Web scraping API for Finnish websites
Author-email: Jesse Myrberg <jesse.myrberg@gmail.com>
License: MIT License        
        Copyright (c) 2022 Jesse Myrberg        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/jmyrberg/finscraper
Project-URL: Documentation, https://finscraper.readthedocs.io
Keywords: web,scraping,finnish,nlp,scrapy
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: Scrapy
Classifier: Natural Language :: Finnish
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: attrs (>=21)
Requires-Dist: pandas (>=1)
Requires-Dist: selenium (>=4)
Requires-Dist: scrapy (>=2.6.3)
Requires-Dist: tqdm (>=4.46)
Requires-Dist: webdriver-manager (>=2.4)
Provides-Extra: dev
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: versioneer ; extra == 'dev'

# finscraper

[![Spiders](https://github.com/jmyrberg/finscraper/actions/workflows/spiders.yml/badge.svg)](https://github.com/jmyrberg/finscraper/actions/workflows/spiders.yml)
[![Documentation](https://readthedocs.org/projects/finscraper/badge/?version=latest)](https://finscraper.readthedocs.io/en/latest/?badge=latest)

![finscraper cover](https://github.com/jmyrberg/finscraper/blob/master/docs/cover.jpg?raw=true)

The library provides an easy-to-use API for fetching data from various Finnish websites:

| Website                                                        | Type              | Spider API class   |
| -------------------------------------------------------------- | ----------------- | ------------------ |
| [Ilta-Sanomat](https://www.is.fi)                              | News article      | `ISArticle`        |
| [Iltalehti](https://www.il.fi)                                 | News article      | `ILArticle`        |
| [YLE Uutiset](https://www.yle.fi/uutiset)                      | News article      | `YLEArticle`       |
| [Suomi24](https://keskustelu.suomi24.fi)                       | Discussion thread | `Suomi24Page`      |
| [Vauva](https://www.vauva.fi)                                  | Discussion thread | `VauvaPage`        |
| [Oikotie Asunnot](https://asunnot.oikotie.fi/myytavat-asunnot) | Apartment ad      | `OikotieApartment` |
| [Tori](https://www.tori.fi)                                    | Item deal         | `ToriDeal`         |

Documentation is available at [https://finscraper.readthedocs.io](https://finscraper.readthedocs.io) and [simple online demo here](https://storage.googleapis.com/jmyrberg/index.html#/demo-projects/finscraper).


## Installation

`pip install finscraper`


## Quickstart

Fetch 10 news articles as a pandas DataFrame from [Ilta-Sanomat](https://is.fi):

```python
from finscraper.spiders import ISArticle

spider = ISArticle().scrape(10)

articles = spider.get()
```

The API is similar for all the spiders:

![Finscraper in action](https://github.com/jmyrberg/finscraper/blob/master/docs/finscraper.gif)


## Contributing

Please see [CONTRIBUTING.md](https://github.com/jmyrberg/finscraper/blob/master/CONTRIBUTING.md) for more information.


---

Jesse Myrberg (jesse.myrberg@gmail.com)
