updated README

This commit is contained in:
SexbearLmao
2021-03-30 00:58:26 -05:00
parent f7e2d0845a
commit 889463f6a7
2 changed files with 12 additions and 3 deletions

View File

@@ -2,6 +2,15 @@
Use this script alongside Calibre to pull any number of articles from [Marxists.org](marxists.org) and convert them into a single ebook. Use this script alongside Calibre to pull any number of articles from [Marxists.org](marxists.org) and convert them into a single ebook.
#NOTE:
This is very much a work in progress, and may break frequently.
The index_crawler.py script seems much more successful so I'm working on that now.
It's roughly the same thing but the way it identifies chapters works better with various authors.
Rather than me documenting the ever-changing CLI, for now just use "python3 index_crawler.py --help". Note that there are placeholder arguments for some unimplemented features.
##Requirements ##Requirements
In addition to the python libraries listed in requirements.txt, this script requires [Calibre](https://calibre-ebook.com/) and its add-on [EpubMerge](https://www.mobileread.com/forums/showthread.php?t=169744). Right now the executables "ebook-merge" and "calibre-debug" must be in your path. In addition to the python libraries listed in requirements.txt, this script requires [Calibre](https://calibre-ebook.com/) and its add-on [EpubMerge](https://www.mobileread.com/forums/showthread.php?t=169744). Right now the executables "ebook-merge" and "calibre-debug" must be in your path.

View File

@@ -133,10 +133,10 @@ def main(cli_args):
parser = ArgumentParser() parser = ArgumentParser()
parser.add_argument('-o', '--output', help='output file name', type=str) parser.add_argument('-o', '--output', help='output file name', type=str)
parser.add_argument('-t', '--title', help='ebook title', type=str) parser.add_argument('-t', '--title', help='ebook title', type=str)
parser.add_argument('-a', '--author', help='ebook author', type=str) parser.add_argument('-a', '--author', help="DOESN'T WORK ebook author", type=str)
parser.add_argument('-g', '--tag', help='apply a tag', action='append') parser.add_argument('-g', '--tag', help='apply a tag', action='append')
parser.add_argument('-I', '--images', help='also attempt to download any images', action='store_true') parser.add_argument('-I', '--images', help='NOT IMPLEMENTED also attempt to download any images', action='store_true')
parser.add_argument('-C', '--auto-cover', help='generate an automatic cover', action='store_true', dest='cover') parser.add_argument('-C', '--auto-cover', help='NOT IMPLEMENTED generate an automatic cover', action='store_true', dest='cover')
parser.add_argument('-T', '--no-trim', help="don't try to trim footer at bottom of chapters", action='store_false', dest='trim') parser.add_argument('-T', '--no-trim', help="don't try to trim footer at bottom of chapters", action='store_false', dest='trim')
parser.add_argument('url', help='url to download', nargs='+') parser.add_argument('url', help='url to download', nargs='+')
#args = parser.parse_args(cli_args) #args = parser.parse_args(cli_args)