[imdb] Remove test md5
[ytdl] / CONTRIBUTING.md
1 Please include the full output of the command when run with `--verbose`. The output (including the first lines) contain important debugging information. Issues without the full output are often not reproducible and therefore do not get solved in short order, if ever.
2
3 Please re-read your issue once again to avoid a couple of common mistakes (you can and should use this as a checklist):
4
5 ### Is the description of the issue itself sufficient?
6
7 We often get issue reports that we cannot really decipher. While in most cases we eventually get the required information after asking back multiple times, this poses an unnecessary drain on our resources. Many contributors, including myself, are also not native speakers, so we may misread some parts.
8
9 So please elaborate on what feature you are requesting, or what bug you want to be fixed. Make sure that it's obvious
10
11 - What the problem is
12 - How it could be fixed
13 - How your proposed solution would look like
14
15 If your report is shorter than two lines, it is almost certainly missing some of these, which makes it hard for us to respond to it. We're often too polite to close the issue outright, but the missing info makes misinterpretation likely. As a commiter myself, I often get frustrated by these issues, since the only possible way for me to move forward on them is to ask for clarification over and over.
16
17 For bug reports, this means that your report should contain the *complete* output of youtube-dl when called with the -v flag. The error message you get for (most) bugs even says so, but you would not believe how many of our bug reports do not contain this information.
18
19 Site support requests **must contain an example URL**. An example URL is a URL you might want to download, like http://www.youtube.com/watch?v=BaW_jenozKc . There should be an obvious video present. Except under very special circumstances, the main page of a video service (e.g. http://www.youtube.com/ ) is *not* an example URL.
20
21 ###  Are you using the latest version?
22
23 Before reporting any issue, type youtube-dl -U. This should report that you're up-to-date. About 20% of the reports we receive are already fixed, but people are using outdated versions. This goes for feature requests as well.
24
25 ###  Is the issue already documented?
26
27 Make sure that someone has not already opened the issue you're trying to open. Search at the top of the window or at https://github.com/rg3/youtube-dl/search?type=Issues . If there is an issue, feel free to write something along the lines of "This affects me as well, with version 2015.01.01. Here is some more information on the issue: ...". While some issues may be old, a new post into them often spurs rapid activity.
28
29 ###  Why are existing options not enough?
30
31 Before requesting a new feature, please have a quick peek at [the list of supported options](https://github.com/rg3/youtube-dl/blob/master/README.md#synopsis). Many feature requests are for features that actually exist already! Please, absolutely do show off your work in the issue report and detail how the existing similar options do *not* solve your problem.
32
33 ###  Is there enough context in your bug report?
34
35 People want to solve problems, and often think they do us a favor by breaking down their larger problems (e.g. wanting to skip already downloaded files) to a specific request (e.g. requesting us to look whether the file exists before downloading the info page). However, what often happens is that they break down the problem into two steps: One simple, and one impossible (or extremely complicated one).
36
37 We are then presented with a very complicated request when the original problem could be solved far easier, e.g. by recording the downloaded video IDs in a separate file. To avoid this, you must include the greater context where it is non-obvious. In particular, every feature request that does not consist of adding support for a new site should contain a use case scenario that explains in what situation the missing feature would be useful.
38
39 ###  Does the issue involve one problem, and one problem only?
40
41 Some of our users seem to think there is a limit of issues they can or should open. There is no limit of issues they can or should open. While it may seem appealing to be able to dump all your issues into one ticket, that means that someone who solves one of your issues cannot mark the issue as closed. Typically, reporting a bunch of issues leads to the ticket lingering since nobody wants to attack that behemoth, until someone mercifully splits the issue into multiple ones.
42
43 In particular, every site support request issue should only pertain to services at one site (generally under a common domain, but always using the same backend technology). Do not request support for vimeo user videos, Whitehouse podcasts, and Google Plus pages in the same issue. Also, make sure that you don't post bug reports alongside feature requests. As a rule of thumb, a feature request does not include outputs of youtube-dl that are not immediately related to the feature at hand. Do not post reports of a network error alongside the request for a new video service.
44
45 ###  Is anyone going to need the feature?
46
47 Only post features that you (or an incapacitated friend you can personally talk to) require. Do not post features because they seem like a good idea. If they are really useful, they will be requested by someone who requires them.
48
49 ###  Is your question about youtube-dl?
50
51 It may sound strange, but some bug reports we receive are completely unrelated to youtube-dl and relate to a different or even the reporter's own application. Please make sure that you are actually using youtube-dl. If you are using a UI for youtube-dl, report the bug to the maintainer of the actual application providing the UI. On the other hand, if your UI for youtube-dl fails in some way you believe is related to youtube-dl, by all means, go ahead and report the bug.
52
53 # DEVELOPER INSTRUCTIONS
54
55 Most users do not need to build youtube-dl and can [download the builds](http://rg3.github.io/youtube-dl/download.html) or get them from their distribution.
56
57 To run youtube-dl as a developer, you don't need to build anything either. Simply execute
58
59     python -m youtube_dl
60
61 To run the test, simply invoke your favorite test runner, or execute a test file directly; any of the following work:
62
63     python -m unittest discover
64     python test/test_download.py
65     nosetests
66
67 If you want to create a build of youtube-dl yourself, you'll need
68
69 * python
70 * make
71 * pandoc
72 * zip
73 * nosetests
74
75 ### Adding support for a new site
76
77 If you want to add support for a new site, you can follow this quick list (assuming your service is called `yourextractor`):
78
79 1. [Fork this repository](https://github.com/rg3/youtube-dl/fork)
80 2. Check out the source code with `git clone git@github.com:YOUR_GITHUB_USERNAME/youtube-dl.git`
81 3. Start a new git branch with `cd youtube-dl; git checkout -b yourextractor`
82 4. Start with this simple template and save it to `youtube_dl/extractor/yourextractor.py`:
83     ```python
84     # coding: utf-8
85     from __future__ import unicode_literals
86
87     from .common import InfoExtractor
88
89
90     class YourExtractorIE(InfoExtractor):
91         _VALID_URL = r'https?://(?:www\.)?yourextractor\.com/watch/(?P<id>[0-9]+)'
92         _TEST = {
93             'url': 'http://yourextractor.com/watch/42',
94             'md5': 'TODO: md5 sum of the first 10241 bytes of the video file (use --test)',
95             'info_dict': {
96                 'id': '42',
97                 'ext': 'mp4',
98                 'title': 'Video title goes here',
99                 'thumbnail': 're:^https?://.*\.jpg$',
100                 # TODO more properties, either as:
101                 # * A value
102                 # * MD5 checksum; start the string with md5:
103                 # * A regular expression; start the string with re:
104                 # * Any Python type (for example int or float)
105             }
106         }
107
108         def _real_extract(self, url):
109             video_id = self._match_id(url)
110             webpage = self._download_webpage(url, video_id)
111
112             # TODO more code goes here, for example ...
113             title = self._html_search_regex(r'<h1>(.*?)</h1>', webpage, 'title')
114
115             return {
116                 'id': video_id,
117                 'title': title,
118                 'description': self._og_search_description(webpage),
119                 # TODO more properties (see youtube_dl/extractor/common.py)
120             }
121     ```
122 5. Add an import in [`youtube_dl/extractor/__init__.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/__init__.py).
123 6. Run `python test/test_download.py TestDownload.test_YourExtractor`. This *should fail* at first, but you can continually re-run it until you're done. If you decide to add more than one test, then rename ``_TEST`` to ``_TESTS`` and make it into a list of dictionaries. The tests will be then be named `TestDownload.test_YourExtractor`, `TestDownload.test_YourExtractor_1`, `TestDownload.test_YourExtractor_2`, etc.
124 7. Have a look at [`youtube_dl/common/extractor/common.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py) for possible helper methods and a [detailed description of what your extractor should return](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py#L38). Add tests and code for as many as you want.
125 8. If you can, check the code with [pyflakes](https://pypi.python.org/pypi/pyflakes) (a good idea) and [pep8](https://pypi.python.org/pypi/pep8) (optional, ignore E501).
126 9. When the tests pass, [add](http://git-scm.com/docs/git-add) the new files and [commit](http://git-scm.com/docs/git-commit) them and [push](http://git-scm.com/docs/git-push) the result, like this:
127
128         $ git add youtube_dl/extractor/__init__.py
129         $ git add youtube_dl/extractor/yourextractor.py
130         $ git commit -m '[yourextractor] Add new extractor'
131         $ git push origin yourextractor
132
133 10. Finally, [create a pull request](https://help.github.com/articles/creating-a-pull-request). We'll then review and merge it.
134
135 In any case, thank you very much for your contributions!
136