Permalink
Browse files

Update documentation

  • Loading branch information...
1 parent 43fedc1 commit ffa6403171031d6b3645a386f585589899ced0f9 Michael Brunton-Spall committed Jan 8, 2010
Showing with 5 additions and 4 deletions.
  1. +5 −4 README.rst
View
@@ -18,14 +18,15 @@ Code Overview
-------------
The code is pretty simple, There is a cronjob in cron.yaml that fires once every 2 minutes and calls /services/fetch_tweets. This is defined in services.py, it makes a twitter call to fetch the search result for #uksnow filter:links.
+
The twitter search result brings back every tweet that has mentioned uksnow and has a URL in it. We fire off a taskqueue for each tweet, storing the tweet data in the task payload.
The queue processes at 5 entries a second, each one calling /services/store_tweet, and analyses the tweet, looking for an image url. We support the 5 most likely image buckets that people use, and calculate the thumbnail image to use on the map. We also look for a postcode. If we have a postcode, we use Googles Geocoder to locate the tweet, and then store it into the datastore.
-When you request '/' you ge back a nice static front, that imports Google maps, and loads '/georss'. This RSS feed is the last 250 tweets, ordered by tweet creation time. Using Googles GGeoXml object automatically creates an overlay with pins on the map.
-We have since added /geojson for anyone else that wants to get our data (limited to 100 items to save processing power).
+
+When you request '/' you get back a nice static front, that imports Google maps, and loads '/georss'. This RSS feed is the last 250 tweets, ordered by tweet creation time. Using Googles GGeoXml object automatically creates an overlay with pins on the map. We have since added /geojson and /kml for anyone else that wants to get our data (limited to 100 items to save processing power).
This code is not quite complete, you will need to create a settings_local.py file that contains TWITTER_USERNAME and TWITTER_PASSWORD so that the twitter search is authenticated and therefore not rate-limited as much.
TODO
----
-Using KML, we can provide custom icons, including the image thumbnail as an icon. It doesn't however look pretty
-With a KML network link, we can be given the geo bounding box you are looking at, and the scale. We could use that to only return say the latest 25 / 50 pictures in the area you are looking. We would need to precompute the bounding boxes at tweet creation time however
+ * Using KML, we can provide custom icons, including the image thumbnail as an icon. It doesn't however look pretty -- DONE
+ * With a KML network link, we can be given the geo bounding box you are looking at, and the scale. We could use that to only return say the latest 25 / 50 pictures in the area you are looking. We would need to precompute the bounding boxes at tweet creation time however

0 comments on commit ffa6403

Please sign in to comment.