Metadata-Version: 2.1
Name: immo-bee
Version: 1.0.1
Summary: Scrapes housing data from German immowelt and returns table.
Home-page: https://github.com/pypa/immo_bee
Author: Dirk Ulbricht
Author-email: dirk.ulbricht@gmail.com
Project-URL: Bug Tracker, https://github.com/pypa/immo_bee/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: selenium>=4.9.0
Requires-Dist: lxml>=4.9.3
Requires-Dist: pandas>=2.1.1
Requires-Dist: urllib3>=1.26.18
Requires-Dist: beautifulsoup4>=4.12.2
Requires-Dist: scikit-learn>=1.3.0

# Immowelt Analyzer
Author: dirk.ulbricht@gmail.com

## Purpose
Scrape housing data from German housing portal Immowelt.de and retrieve as comma separted file.

## Installation

Note: This package depends on Geckodriver that can not be imported using pip. More information here: [Windows](https://github.com/dullibri/hauspreis_getting_ids.git) and for Linux it's `sudo apt install firefox-geckodriver` and for Mac use  `npm install geckodriver`. 


```bash
python -m pip install immo-bee
```

## Usage
### Commandline

```bash
 python -m immo_bee --help
 python -m immo_bee norderstedt hamburg
 ```
This will create a folder *data* on your current working directory (if it is not already there) and saves 4 json files for each location for houses, appartments, for rent and for sale respectively. Additionally it will create a comma separated file including all json files preprocessed and ready for usage.

### Import
If you prefer using immo_bee as a package use:
```python
from immo_bee import bee

list_of_locations = ["norderstedt","hamburg"]
df = bee(list_of_locations)
```
