File: README.rst

package info (click to toggle)
python-libdiscid 1.0-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 664 kB
  • sloc: python: 576; ansic: 104; sh: 14; makefile: 10
file content (76 lines) | stat: -rw-r--r-- 1,864 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
libdiscid Python bindings
=========================

python-libdiscid implements Python bindings for libdiscid using Cython. Both
Python 2 (>= 2.7) and 3 (>= 3.4) are supported.

Dependencies
------------

* libdiscid
* Cython (>= 0.15, optional)
* pkgconfig (optional)

Note that the tarballs come with pre-built C source for the Cython module. So
Cython is only required if one builds python-libdiscid from the git repository
or if one wants to change anything in the Cython module.

If pkgconfig is installed, setup.py uses libdiscid's pkg-config information to
set include directories, libraries to link, etc.

Quick installation guide
------------------------

python-libdiscid is available in some distributions:

* Debian/Ubuntu: ``apt-get install python-libdiscid`` (Python 2) or
  ``apt-get install python3-libdiscid`` (Python 3)

python-libdiscid can be installed via ``pip``::

  pip install python-libdiscid

or by running::

  python setup.py install

If you just want to try it locally, run::

  python setup.py build_ext -i

and hack right away. You can also run::

  python setup.py build

but please make sure that ``build/lib.*`` is in ``sys.path`` before the source
folder.

A note for Windows users
------------------------

There are eggs available from PyPI that don't require the extension module to be
built. If these are used, it is still required to drop a working discid.dll in
``C:\WINDOWS\system32`` (or wherever it can be found).

Usage
-----

::

  from libdiscid import read

  disc = read("/dev/cdrom")
  print("id: {}".format(disc.id))

License
-------

python-libdiscid is released under the Expat license. Check LICENSE for details.

Build status
------------

|TravisCI|_

.. |TravisCI| image:: https://travis-ci.org/sebastinas/python-libdiscid.svg?branch=master
.. _TravisCI: https://travis-ci.org/sebastinas/python-libdiscid