MythTV  master
mythtv/programs/scripts/metadata/Music/discid/__init__.py
Go to the documentation of this file.
1 # Copyright (C) 2013 Johannes Dewender
2 #
3 # This program is free software: you can redistribute it and/or modify
4 # it under the terms of the GNU Lesser General Public License as published by
5 # the Free Software Foundation, either version 3 of the License, or
6 # (at your option) any later version.
7 #
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU Lesser General Public License for more details.
12 #
13 # You should have received a copy of the GNU Lesser General Public License
14 # along with this program. If not, see <http://www.gnu.org/licenses/>.
15 #
16 # Please submit bug reports to GitHub:
17 # https://github.com/JonnyJD/python-discid/issues
18 """Python binding of Libdiscid
19 
20 Libdiscid is a library to calculate MusicBrainz Disc IDs.
21 This module provides a python-like API for that functionality.
22 
23 The user is expected to create a :class:`Disc` object
24 using :func:`read` or :func:`put` and extract the generated information.
25 
26 Importing this module will open libdiscid at the same time
27 and will raise :exc:`OSError` when libdiscid is not found.
28 """
29 
30 from discid.disc import read, put, Disc, DiscError, TOCError
31 from discid.track import Track
32 from discid.libdiscid import get_default_device
33 import discid.libdiscid
34 import discid.disc
35 
36 __version__ = "1.1.0"
37 
38 
39 # these contants are defined here so sphinx can catch the "docstrings"
40 
41 LIBDISCID_VERSION_STRING = discid.libdiscid.LIBDISCID_VERSION_STRING
42 """The version string of the loaded libdiscid in the form `libdiscid x.y.z`.
43 For old versions the string is `libdiscid < 0.4.0`.
44 """
45 
46 FEATURES = discid.libdiscid.FEATURES
47 """The features libdiscid supports for the platform as a list of strings.
48 Some Functions can raise :exc:`NotImplementedError` when a feature
49 is not available.
50 Some features might not be implemented in this python module,
51 see :data:`FEATURES_IMPLEMENTED`.
52 """
53 
54 FEATURES_IMPLEMENTED = discid.disc.FEATURES_IMPLEMENTED
55 """The features implemented in this python module as a list of strings.
56 Some might not be available for your platform, see :data:`FEATURES`.
57 """
discid.track
Definition: track.py:1
discid.libdiscid
Definition: libdiscid.py:1
discid.disc
Definition: disc.py:1