https://github.com/danzigerrr/toronto-live-bikes-share
Toronto Live Bikes Share Information using the open APIs
https://github.com/danzigerrr/toronto-live-bikes-share
Last synced: 6 months ago
JSON representation
Toronto Live Bikes Share Information using the open APIs
- Host: GitHub
- URL: https://github.com/danzigerrr/toronto-live-bikes-share
- Owner: Danzigerrr
- License: mit
- Created: 2023-05-19T11:51:37.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-21T17:55:33.000Z (about 3 years ago)
- Last Synced: 2025-01-22T18:34:33.826Z (over 1 year ago)
- Language: HTML
- Size: 3.85 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Toronto Live Bikes Share Flask Web App
## [Live demo](https://krzysztofnazartoronto.pythonanywhere.com/search_available) of the app
Use [**this link**](https://krzysztofnazartoronto.pythonanywhere.com/search_available) to check the demo of this application hosted by [Pythonanywhere.com](https://pythonanywhere.com).
## The goal of the project
The goal of the project is to create a [Flask](https://flask.palletsprojects.com/en/2.3.x/) web application which allows searching for available bikes and docks in Toronto.
The application uses live data from the bike sharing system [Bike Share Toronto](https://bikesharetoronto.com/).
### Bike Share Toronto
The system offers 24/7 convenient access to 7,246 bikes (6722 mechanical and 524 electric) and 668 stations across Toronto’s vast biking network.
Image source: Wikipedia
Bike Share Toronto publishes JSON files which updates in real-time by connecting to the Bike Share backend software. The open API transmits live data under the General Bikeshare Feed Specification (GBFS).
In order to get the live data the following links can be used:
- [station status](https://tor.publicbikesystem.net/ube/gbfs/v1/en/station_status) - the data describes the capacity and rental availability of the stations. The documentation is available [here](https://github.com/MobilityData/gbfs-json-schema/blob/master/v2.3/station_status.json).
- [station information](https://tor.publicbikesystem.net/ube/gbfs/v1/en/station_information) - the data contains details about the station including system operator, location, year implemented, etc. The documentation is available [here](https://github.com/MobilityData/gbfs-json-schema/blob/master/v2.3/station_status.json).
The data about the station status and station information can be joined using the identification number of the station.
This way the number of available bikes and docks at the particular station can be obtained.
## Installation
### Install virtualenv
[Virtualenv](https://www.freecodecamp.org/news/how-to-setup-virtual-environments-in-python/) is a tool to create isolated Python environments.
It can be installed using the package manager [pip](https://pip.pypa.io/en/stable/).
```bash
pip install virtualenv
```
###Create a virtual environment
In order to create a virtual environment use the following command. Specify python version and the name of your virtual environment.
```bash
python -m venv
```
for example:
```bash
python3.10 -m venv venv
```
### Activate virtual environment
To activate your virtual environment on **Mac** or **Linux**, run the code below:
```bash
source venv/bin/activate
```
To activate your virtual environment on **Windows**, run the code below:
```bash
venv/Scripts/activate.bat //In CMD
venv/Scripts/Activate.ps1 //In Powershell
```
When your virtual environment is ready and active run the command below to install all dependencies within their own copy of the project.
Use the package manager [pip](https://pip.pypa.io/en/stable/).
```bash
pip install -r requirements.txt
```
## Running the project
Firstly, generate your API key at [openrouteservice website](https://openrouteservice.org/).
After generating your key, you can find it in the user dashboard.
Copy it and paste it into the *openrouteservice_api_key.py* file:
Enter the directory *flask_app/* with file *app.py* and run the Python file.
```bash
cd flask_app/
python app.py
```
The application will start on localhost on port 5000.
You can see the results entering this link: [http://127.0.0.1:5000](http://127.0.0.1:5000)
## Main functionalities of the app
### Search for available bikes and docks nearby the specified location
The service is available at [http://127.0.0.1:5000/search_available](http://127.0.0.1:5000/search_available).
The app allows finding K available bikes or docks nearby the given location.
The user can specify the following search parameters:
- Location of the user (latitude and longitude)
- K value - number of the nearest stations to be selected from all stations
- Search type - search for stations with available bikes or docks
The parameters can be inserted into the form:
When ready, the user clicks the "Search" button and after a moment receives the results - a map with markers and routes.
There are three types of markers: red, blue and green.
#### Red marker
**The red marker represents the position of the user.**
The marker is draggable (hold left mouse button and move).
After clicking on it, its current location is copied as the search parameter (a popup as confirmation appears).
#### Green markers
**The green marker represents one of K of the nearest available stations.**
The station fits one of the states depending on the search parameters:
- When searching for **bikes** - the station is active, it is renting vehicles, and has at least one available bike - mechanical or e-bike.
- When searching for **docks** - the station is active, it is accepting vehicle returns, and has at least one available dock.
After clicking on the marker the user can see the details about the station.
This is an example result when *K* equals 3:
#### Blue markers
**The blue markers represent available stations.**
The station is active and has at least one available dock.
After clicking on the marker the user can see the details about the station.
#### Station details
After clicking on a green or blue marker the user can see the details about the station:
- **Address**
- **Bikes available**
- **Bikes available - mechanical**
- **Bikes available - ebike**
- **Docks available**
- **Directions** - two buttons (Walking and Cycling) redirect to directions on Google Maps between the user location and the station.
#### Routes to the nearest markers
**The routes to the nearest stations from the user location are found using [openrouteservice free API](https://openrouteservice.org/).**
The closer the station to the user's location, the greener, wider and opaquer it is.
Routes to station in greater distances are redder, less wide and more transparent.
On hover, the route shows a tooltip "Click for details".
After clicking the route, its details are shown in a popup.
The identification number of the station connected with this route is displayed.
### Search for a convenient connection between two locations using Bike Share Toronto system
The service is available at [http://127.0.0.1:5000/search_directions](http://127.0.0.1:5000/search_directions).
Given a source and destination location, the app presents the route on a map and allows to see it in Google Maps as well.
The user can specify the following search parameters:
- Source location (latitude and longitude)
- Destination location (latitude and longitude)
The parameters can be inserted into the form:
When ready, the user clicks the "Search directions" button and after a moment receives the results - a map with **4 markers** and **3 routes**.
During searching for the most convenient route, the definition of **4 key locations** is needed:
- **source location** - the initial location of the user; represented with the **red marker**
- **bike station location** - the location of the nearest station from the source location with at least one bike available; represented with the **orange marker**
- **dock station location** - the location of the nearest station from the destination location with at least one dock available; represented with the **blue marker**
- **destination location** - the final location of the user; represented with the **green marker**
Searching for the route includes the following steps:
- search for route **by foot** from the **source location** and the **bike station location**; represented with the **red route**
- search for route **by cycling** from the **bike station location** to the **dock station location**; represented with the **orange route**
- search for route **by foot** from the **dock station location** to the **destination location**; represented with the **blue route**
On hover, the route shows a tooltip "Click for details".
After clicking the route, its details are shown in a popup.
The locations (longitude and latitude) connected with the route as well as the profile used during searching for directions are displayed.
On click, the marker displays a popup with its name - it is one of the **4 key locations** defined above.
After clicking on the "Show directions" button, the user is redirected to directions on Google Maps
between the source location and destination location using the 4 key locations as destinations (stops) during the route.
## Future improvements
Based on my experience while using the app, I thought of adding the following functionalities:
- When searching for bikes, add an option to search for mechanical or electrical bikes only. I think it is quite easy to add - it requires filtering the data stored in the Dataframe before displaying it.
- Make the markers representing the source and destination locations on the page responsible for searching directions draggable and clickable. Currently, the user has to insert the longitudes and latitudes manually, which can be time consuming and lead to human errors. The location of the marker might be copied automatically when it is clicked - this would be way more convenient and user-friendly.
- When displaying a route, the time of travel from one point to the other could be displayed. I believe this information is in the response from openrouteservice API, but currently I don’t know how to get it from the response body.
- Adding different map layers to the maps might be a good idea. The folium.LayerControl() method could be used. This improvement would make the user experience better.
## Contributing
Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.
## License
[MIT](https://choosealicense.com/licenses/mit/)