Skip to content

Commit

Permalink
Update documentation and README
Browse files Browse the repository at this point in the history
  • Loading branch information
Antoine Bertin committed Oct 30, 2013
1 parent 0055930 commit 9be6e6f
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 9 deletions.
26 changes: 23 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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
18 changes: 12 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 9be6e6f

Please sign in to comment.