update README.md

hiimivantang · Aug 30, 2016 · c47b481 · c47b481
1 parent f9f5f55
commit c47b481
Showing 1 changed file with 98 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -4,28 +4,104 @@
 
 LTA is responsible for planning, operating, and maintaining Singapore's land transport and systems.
 
-This repository contains a python script to get data from LTA's [datamall][1] (free). 
-
-
-### Available APIs and project status
-
-| description            | freq     | url                                                                 |status|  
-|------------------------|----------|---------------------------------------------------------------------|------| 
-| Bus Arrival            | 1m       | http://datamall2.mytransport.sg/ltaodataservice/BusArrival          | TODO | 
-| Bus Services           | ad-hoc   | http://datamall2.mytransport.sg/ltaodataservice/BusServices         | TODO | 
-| Bus Routes             | ad-hoc   | http://datamall2.mytransport.sg/ltaodataservice/BusRoutes           | TODO | 
-| Bus Stops              | ad-hoc   | http://datamall2.mytransport.sg/ltaodataservice/BusRoutes           | TODO |
-| Taxi Availability      | 2m       | http://datamall2.mytransport.sg/ltaodataservice/Taxi-Availability   | TODO |
-| Carpark Availability   | 1m       | http://datamall2.mytransport.sg/ltaodataservice/CarParkAvailability | TODO |
-| ERP Rates              | ad-hoc   | http://datamall2.mytransport.sg/ltaodataservice/ERPRates            | TODO |
-| Estimated Travel Times | 5m       | http://datamall2.mytransport.sg/ltaodataservice/EstTravelTimes      | TODO |
-| Faulty Traffic Lights  | 2m       | http://datamall2.mytransport.sg/ltaodataservice/FaultyTrafficLights | TODO |
-| Road Openings          | 1d       | http://datamall2.mytransport.sg/ltaodataservice/RoadOpenings        | TODO |
-| Road Works             | 1d       | http://datamall2.mytransport.sg/ltaodataservice/RoadWorks           | TODO |
-| Traffic Images         | 5m       | http://datamall2.mytransport.sg/ltaodataservice/Traffic-Images      | TODO |
-| Traffic Incidents      | 2m       | http://datamall2.mytransport.sg/ltaodataservice/TrafficIncidents    | DONE |
-| Traffic Speed Bands    | 5m       | http://datamall2.mytransport.sg/ltaodataservice/TrafficSpeedBands   | TODO |
-| VMS / EMAS             | 2m       | http://datamall2.mytransport.sg/ltaodataservice/VMS                 | TODO |
+This repository contains a python module to get data from LTA's [datamall][1] (free). Maybe I should not name this repository as LTA-datamall-crawler but you can always create a simple cronjob for crawling purposes.
+
+
+
+### Installation
+
+```python
+
+pip install ltadatamallcrawler
+
+```
+
+Or, you can always clone this project and run the script directly.
+
+
+
+
+### Usage
+
+```bash
+# to view the available APIs:
+
+lta-datamall-crawler -h
+
+
+
+
+# Expected output:
+
+Usage: lta-datamall-crawler [options]
+
+#Options:
+#  -h, --help            show this help message and exit
+#
+#  Available APIs:
+#    Please select one!
+#
+#    --traffic-incidents
+#    --bus-arrival       
+#    --bus-routes        
+#    --estimated-travel-times
+#    --road-openings     
+#    --erp-rates         
+#    --vms-emas          
+#    --taxi-availability
+#    --faulty-traffic-lights
+#    --carpark-availability
+#    --bus-stops         
+#    --traffic-images    
+#    --traffic-speed-bands
+#    --bus-services      
+#    --road-works 
+
+
+
+
+# to get 'real-time' traffic incidents data 
+
+lta-datamall-crawler --traffic-incidents
+
+
+```
+
+
+
+
+### Motivation
+
+Sometimes it can be quite labourous to create boilerplate codes for doing HTTP get requests to different APIs even though the [requests package][2] can make life slightly easier. I've created this project to make life easier for people who are interested in getting traffic data from Singapore LTA datamall. 
+
+
+### Available API
+
+| description            | freq     | url                                                                 |
+|------------------------|----------|---------------------------------------------------------------------| 
+| Bus Arrival            | 1m       | http://datamall2.mytransport.sg/ltaodataservice/BusArrival          | 
+| Bus Services           | ad-hoc   | http://datamall2.mytransport.sg/ltaodataservice/BusServices         | 
+| Bus Routes             | ad-hoc   | http://datamall2.mytransport.sg/ltaodataservice/BusRoutes           | 
+| Bus Stops              | ad-hoc   | http://datamall2.mytransport.sg/ltaodataservice/BusRoutes           |
+| Taxi Availability      | 2m       | http://datamall2.mytransport.sg/ltaodataservice/Taxi-Availability   |
+| Carpark Availability   | 1m       | http://datamall2.mytransport.sg/ltaodataservice/CarParkAvailability |
+| ERP Rates              | ad-hoc   | http://datamall2.mytransport.sg/ltaodataservice/ERPRates            |
+| Estimated Travel Times | 5m       | http://datamall2.mytransport.sg/ltaodataservice/EstTravelTimes      |
+| Faulty Traffic Lights  | 2m       | http://datamall2.mytransport.sg/ltaodataservice/FaultyTrafficLights |
+| Road Openings          | 1d       | http://datamall2.mytransport.sg/ltaodataservice/RoadOpenings        |
+| Road Works             | 1d       | http://datamall2.mytransport.sg/ltaodataservice/RoadWorks           |
+| Traffic Images         | 5m       | http://datamall2.mytransport.sg/ltaodataservice/Traffic-Images      |
+| Traffic Incidents      | 2m       | http://datamall2.mytransport.sg/ltaodataservice/TrafficIncidents    |
+| Traffic Speed Bands    | 5m       | http://datamall2.mytransport.sg/ltaodataservice/TrafficSpeedBands   |
+| VMS / EMAS             | 2m       | http://datamall2.mytransport.sg/ltaodataservice/VMS                 |
+
 
 [1]:https://www.mytransport.sg/content/mytransport/home/dataMall.html
+[2]:https://pypi.python.org/pypi/requests/2.11.1
+
+
+
+### Project Roadmap
 
+* allow HTTP requests with parameters for filtering results
+* create appropriate unittests