Skip to content

A Python package to help plan dates and outings by providing information about art-based events and restaurants within the NYC Metro area based on an initial meeting point.

License

Notifications You must be signed in to change notification settings

connixu/ny_artsy_date

Repository files navigation

ny_artsy_date

This is a Python package to help plan dates and outings by providing information about art-based events and restaurants within the NYC Metro area based on an initial meeting point. This package serves as a wrapper for the NYC ArtBeats API and leverages various functionalities from the Google Maps API (as accessed through googlemaps package as well as gmaps package) to make planning artsy dates and gatherings simple and fun.

The functions within return data tables and maps as needed based on a specified search radius of a starting address. There is also a function (for those who like spontanaeity) to choose_my_art_date, which selects one art-based event and one restaurant nearby based on a starting point. Users can further adjust for a variety of needs, such as search radius from starting point, whether the event is free, and minimum Google Places Rating (for the restaurant).

Note: this package is dependent on the googlemaps and gmaps packages, which acces the Google Maps API. Users should obtain a Google Maps API key to use this package to its full capacity.

Installation

$ pip install ny_artsy_date

You can also clone this Github Repository.

Usage

For more detailed usage cases, please refer to Usage Vignette.

Official Documentation

The official documentation is hosted on Read the Docs: https://ny-artsy-date.readthedocs.io/en/main/

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

ny_artsy_date was created by Connie (Ye) Xu . It is licensed under the terms of the MIT license.

Credits

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

Contact Info

If you have any questions, concerns, or feedback about this package, please contact me at yx2625@columbia.edu.

About

A Python package to help plan dates and outings by providing information about art-based events and restaurants within the NYC Metro area based on an initial meeting point.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages