aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/README.md b/README.md
index 84464f40c..988ed1b13 100644
--- a/README.md
+++ b/README.md
@@ -28,7 +28,9 @@ To install on Hyperbola run:
# DESCRIPTION
**hypervideo** A fork of youtube-dl without nonfree parts
- $ hypervideo [OPTIONS] URL [URL...]
+```console
+$ hypervideo [OPTIONS] URL [URL...]
+```
# OPTIONS
-h, --help Print this help text and exit
@@ -985,7 +987,7 @@ After you have ensured this site is distributing its content legally, you can fo
4. Start with this simple template and save it to `youtube_dl/extractor/yourextractor.py`:
- ```python
+```python
# coding: utf-8
from __future__ import unicode_literals
@@ -1024,7 +1026,8 @@ After you have ensured this site is distributing its content legally, you can fo
'uploader': self._search_regex(r'<div[^>]+id="uploader"[^>]*>([^<]+)<', webpage, 'uploader', fatal=False),
# TODO more properties (see youtube_dl/extractor/common.py)
}
- ```
+```
+
5. Add an import in [`youtube_dl/extractor/extractors.py`](https://github.com/ytdl-org/youtube-dl/blob/master/youtube_dl/extractor/extractors.py).
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 then be named `TestDownload.test_YourExtractor`, `TestDownload.test_YourExtractor_1`, `TestDownload.test_YourExtractor_2`, etc. Note that tests with `only_matching` key in test's dict are not counted in.
7. Have a look at [`youtube_dl/extractor/common.py`](https://github.com/ytdl-org/youtube-dl/blob/master/youtube_dl/extractor/common.py) for possible helper methods and a [detailed description of what your extractor should and may return](https://github.com/ytdl-org/youtube-dl/blob/7f41a598b3fba1bcab2817de64a08941200aa3c8/youtube_dl/extractor/common.py#L94-L303). Add tests and code for as many as you want.