Files
wookiee-dl/README.md
2022-10-25 11:45:25 -05:00

73 lines
1.6 KiB
Markdown

# Wookiee DL
Command line interface of convenience utilities for use with Wookieepedia
(via pywikibot and mediawiki)
# Installation
Simply run:
$ pip install .
# Usage
To use it:
```
$ wookiee-dl --help
Usage: python -m wookiee-dl [OPTIONS] COMMAND [ARGS]...
Command line interface of convenience utilities for use with Wookieepedia
(via pywikibot and mediawiki)
Options:
--version Show the version and exit.
--help Show this message and exit.
Commands:
html Outputs the Wiki page as an HTML document
image Download the main image for a page Requires to know the...
images Dump all images from a given page.
text Return page link in url formats
```
## HTML
```
Usage: python -m wookiee-dl html [OPTIONS] QUERY
Outputs the Wiki page as an HTML document
Options:
-y, --top_result Automatically use the top search result
-o, --output_directory DIRECTORY
-n, --output_filename TEXT
--help Show this message and exit.
```
## Images
```
Usage: python -m wookiee-dl images [OPTIONS] QUERY
Dump all images from a given page.
Options:
-y, --top_result Automatically use the top search result
-o, --output_directory DIRECTORY
--help Show this message and exit.
```
## Text
```
Usage: python -m wookiee-dl text [OPTIONS] QUERY
Return page link in url formats
Options:
-y, --top_result Automatically use the top search result
-f, --format [html|markdown|url]
-o, --output FILE
--help Show this message and exit.
```