README.rst 2.69 KB
Newer Older
Stein Magnus Jodal's avatar
Stein Magnus Jodal committed
1
**************
2
Mopidy-YouTube
Stein Magnus Jodal's avatar
Stein Magnus Jodal committed
3
**************
dz0ny's avatar
dz0ny committed
4

5
6
.. image:: https://img.shields.io/pypi/v/Mopidy-YouTube.svg?style=flat
    :target: https://pypi.python.org/pypi/Mopidy-YouTube/
dz0ny's avatar
dz0ny committed
7
8
    :alt: Latest PyPI version

9
10
.. image:: https://img.shields.io/pypi/dm/Mopidy-YouTube.svg?style=flat
    :target: https://pypi.python.org/pypi/Mopidy-YouTube/
dz0ny's avatar
dz0ny committed
11
12
    :alt: Number of PyPI downloads

Stein Magnus Jodal's avatar
Stein Magnus Jodal committed
13
14
15
16
.. image:: https://img.shields.io/travis/mopidy/mopidy-youtube/develop.svg?style=flat
    :target: https://travis-ci.org/mopidy/mopidy-youtube
    :alt: Travis CI build status

17
.. image:: https://img.shields.io/coveralls/mopidy/mopidy-youtube/develop.svg?style=flat
18
19
    :target: https://coveralls.io/r/mopidy/mopidy-youtube?branch=develop
    :alt: Test coverage
dz0ny's avatar
dz0ny committed
20

Stein Magnus Jodal's avatar
Stein Magnus Jodal committed
21

22
Mopidy extension that plays sound from YouTube.
dz0ny's avatar
dz0ny committed
23
24
25
26
27


Installation
============

28
29
Make sure you already have the GStreamer plugins, especially the "bad"
collection of plugins. For example, on Debian/Ubuntu you can install it by
Stein Magnus Jodal's avatar
Stein Magnus Jodal committed
30
running::
Camilo Nova's avatar
Camilo Nova committed
31

32
    sudo apt-get install gstreamer0.10-plugins-bad
Camilo Nova's avatar
Camilo Nova committed
33

dz0ny's avatar
dz0ny committed
34
35
Install by running::

36
37
38
39
40
    pip install Mopidy-YouTube


Configuration
=============
dz0ny's avatar
dz0ny committed
41

42
43
No configuration needed. The only supported config value is ``youtube/enabled``
which can be set to ``false`` to disable the extension.
dz0ny's avatar
dz0ny committed
44

45
46
47

Usage
=====
dz0ny's avatar
dz0ny committed
48

49
Simply use search for filename in your MPD client or add YouTube URL to
Stein Magnus Jodal's avatar
Stein Magnus Jodal committed
50
playlist prefixed by ``yt:``.
dz0ny's avatar
dz0ny committed
51

52
53
54
55
56
Example video::

    yt:http://www.youtube.com/watch?v=Njpw2PVb1c0

Example for playlist::
dz0ny's avatar
dz0ny committed
57

58
    yt:http://www.youtube.com/playlist?list=PLeCg_YDclAETQHa8VyFUHKC_Ly0HUWUnq
Stein Magnus Jodal's avatar
Stein Magnus Jodal committed
59

dz0ny's avatar
dz0ny committed
60

61
62
Troubleshooting
===============
dz0ny's avatar
dz0ny committed
63

64
65
If resolving of URIs stops working, always try to update the pafy library
first::
Janez Troha's avatar
Janez Troha committed
66

67
   pip install --upgrade pafy
Stein Magnus Jodal's avatar
Stein Magnus Jodal committed
68
69


dz0ny's avatar
dz0ny committed
70
71
72
Project resources
=================

73
74
- `Source code <https://github.com/mopidy/mopidy-youtube>`_
- `Issue tracker <https://github.com/mopidy/mopidy-youtube/issues>`_
dz0ny's avatar
dz0ny committed
75
76
77
78
79


Changelog
=========

Stein Magnus Jodal's avatar
Stein Magnus Jodal committed
80
v2.0.2 (2016-01-19)
81
82
-------------------

83
84
- Fix resolving of ``youtube:video`` URIs when looking up tracks. (Fixes: #21,
  PR: #50)
85

Stein Magnus Jodal's avatar
Stein Magnus Jodal committed
86
87
- Ensure ``None`` doesn't get includes in track image lists. (PR: #48)

Stein Magnus Jodal's avatar
Stein Magnus Jodal committed
88
v2.0.1 (2015-08-19)
89
90
91
92
-------------------

- Update links to GitHub repository.

93
94
- Don't return ``None`` values to Mopidy when lookup or search returns invalid
  data. In Mopidy 1.0, this caused a crash. In Mopidy 1.1, this caused warnings
95
  about the YouTube backend returning invalid data. (Fixes: #28, PR: #35)
96

dz0ny's avatar
dz0ny committed
97
v2.0.0 (2015-04-01)
98
99
100
101
102
103
-------------------

- Require Mopidy >= 1.0.

- Update to work with the new playback API in Mopidy 1.0.

104
105
- Update to work with the new search API in Mopidy 1.0.

Stein Magnus Jodal's avatar
Stein Magnus Jodal committed
106
107
108
109
110
111
112
113
114
115
116
117
v1.0.2 (2015-01-02)
-------------------

- Changelog missing.

v1.0.1 (2014-05-28)
-------------------

- Changelog missing.

v0.1.0 (2014-03-06)
-------------------
dz0ny's avatar
dz0ny committed
118

Janez Troha's avatar
Janez Troha committed
119
- Initial release.