https://github.com/sharedstreets/sharedstreets-python

SharedStreets (Python)
https://github.com/sharedstreets/sharedstreets-python

Last synced: 16 days ago
JSON representation

SharedStreets (Python)

• Host: GitHub
• URL: https://github.com/sharedstreets/sharedstreets-python
• Owner: sharedstreets
• License: mit
• Created: 2018-01-10T19:35:38.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-08-02T18:35:39.000Z (3 months ago)
• Last Synced: 2024-10-14T02:27:53.186Z (about 1 month ago)
• Language: Python
• Homepage: https://sharedstreets.io
• Size: 1.87 MB
• Stars: 64
• Watchers: 11
• Forks: 16
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SharedStreets (Python)

Python implementation of [SharedStreets Reference System](https://github.com/sharedstreets/sharedstreets-ref-system).

## Install

1.  Install [from PyPI with Pip](https://packaging.python.org/tutorials/installing-packages/#installing-from-pypi).

    

        pip install sharedstreets

2.  Try downloading a single tile to GeoJSON.

        sharedstreets-get-tile 16 10509 25324 > 16-10509-25324.geojson

## Use

-   Retrieve a tile and convert to GeoJSON in Python.

        import sharedstreets.tile

        tile = sharedstreets.tile.get_tile(16, 10508, 25324)

        geojson = sharedstreets.tile.make_geojson(tile)

-   Install optional webserver to serve GeoJSON tiles.

        pip install 'sharedstreets[webserver]'

-   Run a debug webserver and request a tile at [`/tile/16/10508/25324.geojson`](http://127.0.0.1:5000/tile/16/10508/25324.geojson).

        sharedstreets-debug-webapp

-   Run a production webserver under [Gunicorn](http://gunicorn.org/).

        gunicorn sharedstreets.webapp:app

-   Install optional Geopandas to use read tabular excerpts of SharedStreets data.

        pip install 'sharedstreets[dataframe]'

-   Read a small area of SharedStreets data into a pair of Geopandas dataframes.

        import sharedstreets.dataframe

        frames = sharedstreets.dataframe.get_bbox(-122.2820, 37.7946, -122.2480, 37.8133)

        geometries, intersections = frames.geometries, frames.intersections

## Develop

Install for local development.

1.  Clone the SharedStreets-Python git repository and prepare a

    [Python virtual environment](http://docs.python-guide.org/en/latest/dev/virtualenvs/#virtualenv) running Python 3.

2.  Install the `sharedstreets` module, keeping it editable, and run test suite.

    

        pip install --editable .

        python setup.py test

## Protobufs

Current `.proto` files can can be found at

[sharedstreets/sharedstreets-ref-system](https://github.com/sharedstreets/sharedstreets-ref-system/tree/master/proto).

[Install `protoc`](https://github.com/google/protobuf) and

[follow Python directions](https://developers.google.com/protocol-buffers/docs/reference/python-generated#invocation)

to regenerate `sharedstreets/sharedstreets_pb2.py` if necessary:

    protoc -I=sharedstreets-ref-system/proto/ \

        --python_out=sharedstreets/ \

        sharedstreets-ref-system/proto/sharedstreets.proto