Updated README and AUTHORS.

AUTHORS

@@ -0,0 +1,4 @@
+Author: Nick Ficano <[email protected]>
+
+Contributors:
+Lorenzo Gil Sanchez <[email protected]>

README.md

@@ -0,0 +1,114 @@
+![pytube](https://s3.amazonaws.com/assets.nickficano.com/pytube_logo.png)
+
+# A lightwight, dependency-free YouTube Video download library, written in Python.
+
+Downloading videos from YouTube shouldn't require some bloatware application,
+its usually a niche condition you need to do so in the first place.
+
+## Background
+
+After missing the deadline to register for PyCon 2012, I decided to write what
+became PyTube and crawler to collect all the YouTube links for the talks
+on [PyVideos.org](http://pyvideo.org/).
+
+To avoid having to encode them to mp4 (so I could watch them on my iPhone)
+I wrote it so you could specify an encoding format.
+
+In recently weeks interest has picked up in the project, so I decided to
+dedicate more time to further its development and actively maintain it.
+
+## Principals 
+
+My only real goals for this is to never require any third party dependancies,
+to keep it simple and make it reliable.
+
+## Planned Features
+
+The only features I see implementing in the near future are:
+
+- Allow it to run as a command-line utility. 
+- Making it compatible with Python 3.
+
+
+## Usage
+
+``` python
+from youtube import YouTube
+
+# not necessary, just for demo purposes
+from pprint import pprint as pp
+
+yt = YouTube()
+
+# Set the video URL.
+yt.url = "http://www.youtube.com/watch?v=Ik-RsDGPI5Y"
+
+# Once set, you can see all the codec and quality options YouTube has made
+# available for the perticular video by printing videos.
+
+pp(yt.videos)
+
+#[<Video: 3gp - 144p>,
+# <Video: 3gp - 144p>,
+# <Video: 3gp - 240p>,
+# <Video: 3gp - 240p>,
+# <Video: flv - 224p>,
+# <Video: flv - 224p>,
+# <Video: flv - 360p>,
+# <Video: flv - 360p>,
+# <Video: flv - 480p>,
+# <Video: flv - 480p>,
+# <Video: mp4 - 360p>,
+# <Video: mp4 - 360p>,
+# <Video: mp4 - 720p>,
+# <Video: mp4 - 720p>,
+# <Video: webm - 360p>,
+# <Video: webm - 360p>,
+# <Video: webm - 480p>,
+# <Video: webm - 480p>]
+
+# The filename is automatically generated based on the video title.
+# You can override this by manually setting the filename.
+
+# view the auto generated filename:
+print yt.filename
+
+#Pulp Fiction - Dancing Scene [HD]
+
+# set the filename:
+yt.filename = 'Dancing Scene from Pulp Fiction'
+
+# You can also filter the criteria by filetype.
+
+pp(yt.filter('flv'))
+
+# [<Video: flv - 224p>,
+# <Video: flv - 224p>,
+# <Video: flv - 360p>,
+# <Video: flv - 360p>,
+# <Video: flv - 480p>,
+# <Video: flv - 480p>]
+
+# and by resolution
+pp(yt.filter(res='480p'))
+
+# [<Video: flv - 480p>,
+# <Video: flv - 480p>,
+# <Video: webm - 480p>,
+# <Video: webm - 480p>]
+
+# to select a video by a specific resolution and filetype you can use the get
+# method.
+
+video = yt.get('mp4', '720p')
+
+# Okay, let's download it!
+video.download()
+
+# Downloading: Pulp Fiction - Dancing Scene.mp4 Bytes: 37561829
+# 37561829  [100.00%]
+
+# Note: If you wanted to choose the output directory, simply pass it as an 
+# argument to the download method.
+video.download('/tmp/')
+```

README.rst

@@ -1,51 +0,0 @@
-python-youtube-downloader
-=========================
-Still needs a bit of cleaning up, and has a couple bugs, not bad for a
-couple hours of hackin'. I should have them fixed quickly though. Enjoy!
-
-TODO
-----
-1. Add a couple small features, like output path.
-2. Write unit tests.
-3. Add setup.py.
-
-Installation
-------------
-1. Add it to your PYTHON PATH if you'd like, not much to her.
-
-Usage example
--------------
-::
-
-    >>> from youtube import YouTube
-    >>> yt = YouTube()
-    >>> yt.url = "http://www.youtube.com/watch?v=Ik-RsDGPI5Y"
-
-    >>> # View all encoding/quality options.
-    >>> yt.videos
-    [<Video: mp4 - 720p>,
-    <Video: webm - 480p>,
-    <Video: flv - 480p>,
-    <Video: webm - 360p>,
-    <Video: flv - 360p>,
-    <Video: mp4 - 360p>,
-    <Video: flv - 224p>]
-
-    >>> #Set the filename, or get the default.
-    >>> yt.filename
-    'Pulp Fiction - Dancing Scene'
-
-    >>> # Similar to the Django ORM, you can filter.
-    >>> yt.filter('flv')
-    [<Video: flv - 480p>, <Video: flv - 360p>, <Video: flv - 224p>]
-
-    >>> yt.filter(res='480p')
-    [<Video: webm - 480p>, <Video: flv - 480p>]
-
-    >>> # You can even use get()
-    >>> video = yt.get('mp4', '720p')
-
-    >>> # Okay, let's download!
-    >>> video.download()
-    Downloading: Pulp Fiction - Dancing Scene.mp4 Bytes: 37561829
-    37561829  [100.00%]

TODO

@@ -1,19 +1,12 @@
 TODO
 ====
 
-Short Term
-----------
-* Reimplement as Abstract Base Class.
-* Allow an output directory to be specified.
-* Unbind the filename from the Video class, to allow graceful file renaming.
-* Throw custom exceptions.
+* Refactor filename out of ``Video`` class, allowing for graceful file
+  renaming. At present, the filename must be set before defining the url.
+* Better handling and/or conditionally raising exceptions.
+* Add setup.py.
 * Detect duplicate video encoding options, preventing the creation of identical
     video class instances. (can cause get() method to raise unnecessary
     multiple returned excepion).
-
-Long Term
-----------
-* OS Compatibility testing of automatic filename generation.
-* Improve automatic filename generation.
 * Add functionality for batch URL processing.
 * Scrape and inject additional video information into metadata.