pynyairbnb

A package for DSCI 310 Group's Airbnb Analysis.

Installation

$ pip install pynyairbnb

Usage

pynyairbnb can be used to load data from insideairbnb.com's NYC Airbnb Open Data, perform all necessary preprocessing necessary, generate visualizations, build a knn-classification model and conduct a hyperparameter optimization on the model as follows:

from pynyairbnb.data_preprocessing import data_preprocessing
from pynyairbnb.plotting import plot_pynyairbnb
from pynyairbnb.pynyairbnb import nyairbnb_analysis

data_preprocessing("example-link-data.csv", "documents/data_files", "./data/raw")  # url to your data and path to save your data
plot_pynyairbnb("documents/data_files/train_df.csv", "documents/data_figures", "documents/data_tables") # path to data files and output paths to save figures and tables
nyairbnb_analysis("documents/data_files", "documents/data_tables") # path to data files and output path to save tables

All outputs get saved as .csv or .jpg files that you can read in using the pandas.read_csv() function or the matplotlib.pyplot.imread() function respectively.

Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

License

pynyairbnb was created by by the members of Group 9 for DSCI 310. It is licensed under the terms of the MIT license.

Please refer to LICENSE.md for detailed licensing information.

Credits

pynyairbnb was created with cookiecutter and the py-pkgs-cookiecutter template.

This package also utilizes New York City Airbnb Open Data from insideairbnb.com for example demonstrations.

Contributors

Rashi Selarka

Riddhi Battu

Oliver Gullery

Prithvi Sureka