Browse files

Update documentation and README

  • Loading branch information...
1 parent 0055930 commit 9be6e6f8d2499dc3938ca0865adfa5a880b7bb63 @Diaoul committed Oct 30, 2013
Showing with 35 additions and 9 deletions.
  1. +23 −3 README.rst
  2. +12 −6 docs/index.rst
View
26 README.rst
@@ -1,7 +1,27 @@
-Enzyme: video metadata parser
-=============================
+Enzyme
+======
+
+Enzyme is a Python module to parse video metadata.
.. image:: https://travis-ci.org/Diaoul/enzyme.png?branch=master
:target: https://travis-ci.org/Diaoul/enzyme
-Enzyme is an `Apache2 Licensed <http://opensource.org/licenses/Apache-2.0>`_ video metadata parser library written in Python.
+
+Usage
+-----
+Parse a MKV file::
+
+ >>> with open('How.I.Met.Your.Mother.S08E21.720p.HDTV.X264-DIMENSION.mkv', 'rb') as f:
+ ... mkv = enzyme.MKV(f)
+ ...
+ >>> mkv.info
+ <Info [title=None, duration=0:20:56.005000, date=2013-04-15 14:06:50]>
+ >>> mkv.video_tracks
+ [<VideoTrack [1, 1280x720, V_MPEG4/ISO/AVC, name=None, language=eng]>]
+ >>> mkv.audio_tracks
+ [<AudioTrack [2, 6 channel(s), 48000Hz, A_AC3, name=None, language=und]>]
+
+
+License
+-------
+Apache2
View
18 docs/index.rst
@@ -7,21 +7,27 @@ Enzyme
======
Release v\ |version|
-Enzyme is a Python module to handle video metadata.
+Enzyme is a Python module to parse video metadata.
-Features
---------
+
+Usage
+-----
Parse a MKV file::
>>> with open('How.I.Met.Your.Mother.S08E21.720p.HDTV.X264-DIMENSION.mkv', 'rb') as f:
... mkv = enzyme.MKV(f)
...
>>> mkv.info
- Info(title=None, duration=0:20:56.005000, date=2013-04-15 14:06:50)
+ <Info [title=None, duration=0:20:56.005000, date=2013-04-15 14:06:50]>
>>> mkv.video_tracks
- [VideoTrack(1, 1280x720, V_MPEG4/ISO/AVC, name=None, language=eng)]
+ [<VideoTrack [1, 1280x720, V_MPEG4/ISO/AVC, name=None, language=eng]>]
>>> mkv.audio_tracks
- [AudioTrack(2, 6 channel(s), 48000Hz, A_AC3, name=None, language=und)]
+ [<AudioTrack [2, 6 channel(s), 48000Hz, A_AC3, name=None, language=und]>]
+
+
+License
+-------
+Apache2
API Documentation

0 comments on commit 9be6e6f

Please sign in to comment.