← Back to branch summary

~ubuntu-branches/ubuntu/vivid/python-libdiscid/vivid

« back to all changes in this revision

Viewing changes to docs/source/installation.rst

  • Committer: Package Import Robot
  • Author(s): Sebastian Ramacher
  • Date: 2013-10-03 17:32:00 UTC
  • mfrom: (1.1.2)
  • Revision ID: package-import@ubuntu.com-20131003173200-1p3qlyl3aj14y81k
Tags: 0.4-1
* New upstream version.
* debian/patches:
  - skip-read-tests-if-not-available.patch: Removed, no longer needed.
  - sphinx-documentation.patch: Refreshed.
* debian/control: Bump libdiscid0-dev to >= 0.6 for new features.
* debian/{rules,python-libdiscid-doc.docs}: Update for new path of the
  documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/source/installation.rst
1
 
Installation
2
 
------------
3
 
 
4
 
Dependencies
5
 
^^^^^^^^^^^^
6
 
 
7
 
`python-libdiscid` depends on the following components:
8
 
 
9
 
* :musicbrainz:`libdiscid`
10
 
* `Cython`__ (>= 0.15)
11
 
 
12
 
On Debian based systems, the dependencies are only an `apt-get` away::
13
 
 
14
 
 apt-get install cython libdiscid0-dev
15
 
 
16
 
`Cython` is also available via `PyPI`__::
17
 
 
18
 
 pip install cython
19
 
 
20
 
.. __: http://www.cython.org/
21
 
.. __: https://pypi.python.org/pypi/Cython/
22
 
 
23
 
PyPI
24
 
^^^^
25
 
 
26
 
`python-libdiscid` is available from `PyPI`__::
27
 
 
28
 
 pip install libdiscid
29
 
 
30
 
You can also download the tarball from `PyPI`__ manually, unpack
31
 
it and run::
32
 
 
33
 
 python setup.py install
34
 
 
35
 
A note for Windows users
36
 
~~~~~~~~~~~~~~~~~~~~~~~~
37
 
 
38
 
There are eggs available from the same source too. With these eggs, the
39
 
extension module comes pre-built. However, you still need to fetch
40
 
`discid.dll` from :musicbrainz:`libdiscid` and copy the DLL to somewhere it can
41
 
be found, e.g. in ``C:\WINDOWS\system32``.
42
 
 
43
 
.. __: https://pypi.python.org/pypi/python-libdiscid/
44
 
.. __: https://pypi.python.org/pypi/python-libdiscid/
45
 
 
46
 
Building python-libdiscid locally
47
 
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
48
 
 
49
 
If you just want to try `python-libdiscid` without installing, please note that
50
 
per default `setuptools` will build the extension module in ``build/lib.*`` and
51
 
doesn't copy it to ``libdiscid``. There are many possible ways to work with this
52
 
limitation:
53
 
 
54
 
* Running::
55
 
 
56
 
   python setup.py build_ext -i
57
 
 
58
 
  will copy the extension modules to ``libdiscid`` and one can hack right away.
59
 
 
60
 
* Use `setuptools` ``develop`` command. Please read `setuptools`'s
61
 
  `documentation`__ for further information.
62
 
 
63
 
* If you build with ``python setup.py build``, It is also possible to put
64
 
  ``build/lib.*`` before the source directory of `python-libdiscid` in
65
 
  ``sys.path``. Assuming that `python-libdiscid` is built on a 64 bit Linux and
66
 
  for `Python` 3.2, one can use the following lines to achieve that::
67
 
 
68
 
    import sys, os
69
 
    sys.path.insert(0, os.path.abspath('build/lib.linux-x86_64-3.2'))
70
 
    import libdiscid
71
 
 
72
 
  Please note that modification to any file in the ``libdiscid`` directory will
73
 
  only be available after another run of ``python setup.py build``.
74
 
 
75
 
.. __: http://pythonhosted.org/distribute/setuptools.html#development-mode