Metadata-Version: 2.1
Name: vilnius-aroudas-scraper
Version: 0.0.5
Summary: Aroudas.lt website scraper
Home-page: https://github.com/u-aaa/Vilnius-Apartment-Predictions
Author: Blessing E-Philips
Author-email: blessingphilips@ymail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/u-aaa/Vilnius-Apartment-Predictions/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# The Aroudas Web-scraper
## Description

This web_scraper is designed to collect the following information for apartments listed on the [Aroudas website](https://en.aruodas.lt/).
* City
* Sub-district
* Description
* Link
* Building number
* Flat number
* Area
* Price per month
* Build year
* Building type
* Heating system
* Energy class
* Nearest kindergarten
* Nearest educational institution
* Nearest stop
* Nearest public transport stop

The scraper has 3 methods:
* scrape - Loops through webpages and scrapes data off the [aroudas.lt](https://en.aruodas.lt/) website.
* to_csv - Used to save the dataframe to csv
* scrape_to_csv - Used to scrape and save the data to csv

### Usage
To use the scaper, pip install the package.
```python
pip install vilnius-aroudas-scraper

import aroudas_scraper

one_four_rooms = AroudasScraper()

# to scrape and data
df = one_four_rooms.scrape(num_houses=100, room_min=1, room_max=3)

# to save scraped data to csv
one_four_rooms.to_csv(df)

# to scrape and save data to csv
one_four_rooms.scrape_to_csv(num_houses=100, room_min=1, room_max=3)

```

## License
The MIT License - Copyright (c) 2021 - Blessing Ehizojie-Philips


