Skip to content
Browse files

Readme & license

  • Loading branch information...
1 parent c48683a commit a7051e79920d80552eb05a7c7080618a42f5c64e @ept committed Feb 5, 2012
Showing with 69 additions and 0 deletions.
  1. +20 −0 LICENSE
  2. +49 −0 README.md
View
20 LICENSE
@@ -0,0 +1,20 @@
+Copyright (c) 2012 Martin Kleppmann
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
49 README.md
@@ -0,0 +1,49 @@
+CoTweet Exporter
+================
+
+[CoTweet Standard Edition](http://standard.cotweet.com/), a Twitter client for businesses,
+is being [shut down](http://pages.exacttarget.com/socialengagefaq) on 15 February 2012.
+
+Irritatingly, CoTweet [are not providing](https://twitter.com/cotweet/status/165208168912261120)
+a way to export the data from your account. (Not cool, if you ask me.) This little Ruby
+application fills that gap.
+
+
+Features
+--------
+
+* Download the entire contents of your inbox, sent folder and archived messages folder
+ to JSON files on your disk.
+* For every Twitter user you've communicated with, dumps the conversation history
+ with that user. (This is CoTweet's best feature, because you can avoid getting
+ embarrassed by saying the same thing again to the same person.)
+* ROFLscale concurrency using asynchronous network I/O. (Not that it was needed, of
+ course -- I just felt like writing it with
+ [em-http-request](https://github.com/igrigorik/em-http-request) and
+ [DG](https://github.com/samstokes/deferrable_gratification).)
+* Automatic retry of failed requests, to cope with CoTweet's loltastic API.
+
+The JSON files are in the schema used by CoTweet's internal API. They are not documented,
+but the format is pretty self-explanatory.
+
+To my knowledge, there aren't yet any tools to import this data (though of course you can
+grep through it if you need to). Let me know if you write something that uses the data.
+
+
+Usage
+-----
+
+ $ git clone https://github.com/ept/cotweet-export.git && cd cotweet-export
+ $ gem install bundler && bundle install
+ $ mkdir conversations
+ $ bin/cotweet-export
+
+Tested with Ruby 1.9.2.
+
+
+License
+-------
+
+MIT License (see LICENSE).
+
+Patches and pull requests welcome.

0 comments on commit a7051e7

Please sign in to comment.
Something went wrong with that request. Please try again.