pyplaces 0.4.5 documentation

Note

pyplaces is still in development, so if you run into any bugs please report them here.

Pyplaces is a Python package that allows you to easily read places data from a known address, place, or just a bounding box. Currently, the two sources are Overture Maps and Foursquare Open Places, and Open Street Maps Layercake. Overture Maps provides support to get data from multiple versions of the dataset for its many themes. Foursquare Open Places is primarily point of interest data which also supports fetching multiple versions of the dataset. OSM Layercake has buildings and highways data.

The available datasets are: Foursquare Places and Categories; Overture Places, Addresses, Transportation, Buildings, and Base layers.

Quickstart

Installation

This package is available on PyPI as well as conda-forge:

pip install pyplaces

I recommend that you use Anaconda for your Python environments. (I use miniforge and mamba):

conda install pyplaces

Basic Usage

To access places, all you need is a place, address, or bounding box:

from pyplaces.foursquare_open_places import foursquare_places_from_address

hemenway_st_places = foursquare_places_from_address("204 Hemenway Street, Boston, MA")

Additionally, you can:

• Select and filter on columns using SQL

• Get data from past releases

• Inspect dataset schemas

• Find relevant category names for retrieving places data

Most of the functions follow the same type of workflow.

User Reference

• User Reference
  • Dataset Information
    • Dataset Schemas and Additional Information
  • Formatting parameters
    • Filtering and Accessing Dictionary Columns
    • Finding Categories
    • Versions
    • Overture Maps Releases
    • Foursquare Open Places Releases
  • Modules
    • pyplaces.overture_maps
    • pyplaces.foursquare_open_places
    • pyplaces.open_street_maps_layercake

Examples

• Examples
  • Evaluate buildings and places around a real estate listing in Somerville
  • Find bagel shops in New York City
  • Get the transportation network in Detroit, MI
  • Find restaurants near a business hub for site suitability in Chicago

License

pyplaces is open source and licensed under the MIT license.

pyplaces Usage

This package uses a geocoder that uses OpenStreetMaps’s geocoding service Nominatim. Please abide by their usage policy here.

Future Support

• more readable schema output

• more filter operators

• reduce time in the pyarrow parquet reading pipeline

• speed up model transactions- current implementation is inefficient

• support more geoparquet datasets

• basic network analysis for transportation data