Permalink
Browse files

Finally updated the README

  • Loading branch information...
1 parent f2ea015 commit b6087b7700959b734811e23e4f8c56e925e55978 @mrowl committed Sep 13, 2011
Showing with 13 additions and 4 deletions.
  1. +13 −4 README.md
View
17 README.md
@@ -1,21 +1,30 @@
filmdata
========
-This library will fetch raw data from the following sources:
+Technically I use this to import lots of film data for my site, [filmlust](http://filmlust.com), but it's mostly just a playground for me. I see something that looks interesting and I bring it in here and build a prototype to experiment with it (mainly because that's how I learn). For instance, buried deep in the bowels of the code lies at least 3 implementations for scrapers (using tornado, gevent, and twisted. I think I'm going to settle on gevent, btw).
+
+Sometimes things will reach a quiescent point and I clean it up a bit (e.g. the dynamic sqlalchemy models for automagically making tables for plugins). I guess what I'm saying is use at your own risk and feel free to contribute because there are probably many superior solutions out there and I'd like to see them.
+
+Anyway, this thing will fetch raw data from the following sources:
* [imdb](http://www.imdb.com/interfaces)
* [netflix](http://developer.netflix.com/)
+* [flixster/rotten tomatoes](http://developer.rottentomatoes.com/)
+
+That data is then imported into one of the following sinks:
+
+* [MongoDB](http://www.mongodb.org)
-That data is then imported into the following sinks:
+The following sinks are currently broken:
* [SQLAlchemy](http://www.sqlalchemy.org) (use your preferred relational db behind it)
-Coming soon: freebase source and mongodb sink
+Coming soon: freebase source? box office data? sqlalchemy working?
Usage
-----
-Copy the `config_sample.ini` to `config.ini` and edit it to your liking
+Copy the `config_sample.ini` to `config.ini` and edit it to your liking. There are also a couple more static options in the base `__init__.py` file.
This will show you all the options for fetching and importing:

0 comments on commit b6087b7

Please sign in to comment.