diff --git a/README.md b/README.md index dd6d620..d19cda6 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,39 @@ # epub2go.py -web to epub converter for https://projekt-gutenberg.org. +Web to ePUB Converter for [projekt-gutenberg.org](https://projekt-gutenberg.org) developed in conjunction with a [web interface](https://github.com/eneller/epub2go-web). + +## Installation Requires: - [pandoc](https://pandoc.org/) - [wget](https://www.gnu.org/software/wget/) -- [fzf](https://github.com/junegunn/fzf) (only for interactive mode) -- python (duh) -## Usage -Invoke the script using the url of any page of the book you would like to download: -``` -epub2go https://www.projekt-gutenberg.org/ibsen/solness/ +- [fzf](https://github.com/junegunn/fzf) (optional, only for interactive mode) +- [python](https://www.python.org/) (duh) + +Assuming you have a recent version of python installed, run + +``` +pip install git+https://github.com/eneller/epub2go.py +``` +This will provide the `epub2go` command. + +## Usage +``` +Usage: epub2go [OPTIONS] [ARGS]... + + Download ePUBs from https://www.projekt-gutenberg.org/ + + Provide either 0 arguments to enter interactive mode or an arbitrary number + of URLs to download from + +Options: + -d, --debug Set the log level to DEBUG + -s, --silent Disable the progress bar + -p, --path TEXT The path to which files are saved + --no-clean Do not parse html files with blocklist + --help Show this message and exit. +``` + +Examples: +```bash +epub2go https://www.projekt-gutenberg.org/ibsen/solness/ +epub2go # will enter interactive mode ``` -## Installation - Assuming you have a recent version of python installed, run - ``` - pip install git+https://github.com/eneller/epub2go.py - ``` - This will provide the 'epub2go' command. diff --git a/src/epub2go/convert.py b/src/epub2go/convert.py index 8ad5405..59bf48a 100644 --- a/src/epub2go/convert.py +++ b/src/epub2go/convert.py @@ -164,7 +164,7 @@ def get_all_books() -> List[Book]: @click.argument('args', nargs=-1) def main(args, debug, silent, path, no_clean): ''' - Download ePUBs from https://www.projekt-gutenberg.org/ + Download ePUBs from https://www.projekt-gutenberg.org/ \n Provide either 0 arguments to enter interactive mode or an arbitrary number of URLs to download from ''' logging.basicConfig(level=logging.ERROR,format='%(asctime)s - %(levelname)s - %(message)s')