Added debug, output directory and version info options to the CLI

- src/fichub_cli.py: Added debug, output directory and version info options
- src/util.py: Added logging for debug mode
- setup.py: Added long_description & classifiers
- Added README.md, MANIFEST.in, setup.cfg, pyproject.toml

Author: arzkar

LICENSE LICENSE.txt

@@ -0,0 +1,6 @@
+include pyproject.toml
+include *.md
+include LICENSE.txt
+include setup.py
+global-exclude *.pyc
+recursive-include src *.py

MANIFEST.in

@@ -0,0 +1,42 @@
+<h1 align="center">fichub-cli</h1>
+
+A CLI for the fichub.net API<br>
+
+# Installation
+
+## Pip method
+
+Install the package using pip
+
+```
+pip install -U fichub_cli
+```
+
+## Executable method
+
+Download the executables from [Releases](https://github.com/FicHub/fichub-cli/releases) and run them.
+
+### Linux
+
+```
+\.fichub_cli --help
+```
+
+# Usage
+
+```
+> fichub_cli --help
+Usage: fichub_cli [OPTIONS]
+
+Options:
+  -i, --infile TEXT    Give a filename to read URLs from
+  -o, --out_dir TEXT   Output directory for files
+  -f, --format TEXT    Download Format: epub(default), mobi, pdf or html
+  -l, --list_url TEXT  Enter a list of urls to download separated by comma
+                       enclosed in quotes
+
+  -u, --url TEXT       The url of the fanfiction
+  -d, --debug          Debug mode
+  -v, --version        Display version & quit.
+  --help               Show this message and exit.
+```

README.md

@@ -0,0 +1,5 @@
+[build-system]
+# These are the assumed default build requirements from pip:
+# https://pip.pypa.io/en/stable/reference/pip/#pep-517-and-518-support
+requires = ["setuptools>=52.0.0", "wheel"]
+build-backend = "setuptools.build_meta"

pyproject.toml

@@ -4,6 +4,7 @@ chardet==4.0.0
 click==7.1.2
 flake8==3.9.1
 idna==2.10
+loguru==0.5.3
 mccabe==0.6.1
 pip==21.0.1
 pycodestyle==2.7.0

requirements.txt

@@ -0,0 +1,3 @@
+[metadata]
+license-file = LICENSE.txt
+description-file = README.md

setup.cfg

@@ -1,11 +1,18 @@
 from setuptools import setup, find_packages
 
+with open("README.md", "r") as f:
+    long_description = f.read()
+
 setup(
     name='fichub-cli',
     author='arzkar',
     author_email="[email protected]",
-    description="A CLI for the fichub.net API",
+    description="A CLI tool for the fichub.net API",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     version='0.1',
+    license='MIT',
+    url="https://github.com/FicHub/fichub_cli",
     package_dir={"": "src"},
     packages=find_packages(where="src"),
     include_package_data=True,
@@ -17,4 +24,12 @@
         [console_scripts]
         fichub_cli=fichub_cli:cli
     ''',
+    classifiers=[
+        'Development Status :: 5 - Stable',
+        'Intended Audience :: Developers',
+        'Topic :: Software Development :: CLI Tool',
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
 )

setup.py

@@ -26,4 +26,4 @@ def get_fic_data(url, format_type):
     download_url = "https://fichub.net"+cache_url
     data = requests.get(download_url, allow_redirects=True).content
 
-    return fic_name + file_format, data
+    return fic_name, file_format, data

src/fichub.py

@@ -4,18 +4,24 @@
 
 
 @click.command()
-@click.option('-i', '--INFILE', default=None, help='Give a filename to read URLs from')
-@click.option('-f', '--FORMAT', default="epub", help='Download Format: epub(default), mobi, pdf or html')
-@click.option('-l', '--list_URL', default=None, help='Enter a list of urls to download separated by comma enclosed in quotes')
-@click.option('-u', '--URL', default=None, help='The url of the fanfiction')
-def cli(INFILE, URL, list_URL, FORMAT):
+@click.option('-i', '--infile', default=None, help='Give a filename to read URLs from')
+@click.option('-o', '--out_dir', default="", help='Output directory for files')
+@click.option('-f', '--format', default="epub", help='Download Format: epub(default), mobi, pdf or html')
+@click.option('-l', '--list_url', default=None, help='Enter a list of urls to download separated by comma enclosed in quotes')
+@click.option('-u', '--url', default=None, help='The url of the fanfiction')
+@click.option('-d', '--debug', default=False, help='Debug mode', is_flag=True)
+@click.option('-v', '--version', default=False, help='Display version & quit.', is_flag=True)
+def cli(infile, url, list_url, format, out_dir, debug, version):
 
-    format_type = get_format_type(FORMAT)
-    if INFILE:
-        get_fic_with_infile(INFILE, format_type)
+    format_type = get_format_type(format)
+    if infile:
+        get_fic_with_infile(infile, format_type, out_dir, debug)
 
-    elif list_URL:
-        get_fic_with_list(list_URL, format_type)
+    elif list_url:
+        get_fic_with_list(list_url, format_type, out_dir, debug)
 
-    elif URL:
-        get_fic_with_url(URL, format_type)
+    elif url:
+        get_fic_with_url(url, format_type, out_dir, debug)
+
+    if version:
+        click.echo("Version: 0.1")

src/fichub_cli.py

@@ -1,4 +1,6 @@
 import click
+from loguru import logger
+
 from fichub import get_fic_data
 
 
@@ -21,7 +23,7 @@ def get_format_type(format):
     return format_type
 
 
-def get_fic_with_infile(infile=None, format_type=0):
+def get_fic_with_infile(infile=None, format_type=0, out_dir="", debug=False):
 
     with open(infile, "r") as f:
         urls = f.read().splitlines()
@@ -30,28 +32,40 @@ def get_fic_with_infile(infile=None, format_type=0):
     with click.progressbar(urls, label=f"Downloading {len(urls)} files", length=len(urls)) as bar:
         for url in bar:
             count += 1
-            file_name, data = get_fic_data(url, format_type)
-            with open(file_name, "wb") as f:
+            fic_name, file_format, data = get_fic_data(url, format_type)
+
+            if debug:
+                logger.debug(f"Downloading {count}/{len(urls)}: {fic_name}")
+
+            with open(out_dir+fic_name+file_format, "wb") as f:
                 f.write(data)
 
 
-def get_fic_with_list(list_url=None, format_type=0):
+def get_fic_with_list(list_url=None, format_type=0, out_dir="", debug=False):
 
     urls = list_url.split(",")
 
     count = 1
     with click.progressbar(urls, label=f"Downloading {len(urls)} files",  length=len(urls)) as bar:
         for url in bar:
             count += 1
-            file_name, data = get_fic_data(url, format_type)
-            with open(file_name, "wb") as f:
+            fic_name, file_format, data = get_fic_data(url, format_type)
+
+            if debug:
+                logger.debug(f"Downloading {count}/{len(urls)}: {fic_name}")
+
+            with open(out_dir+fic_name+file_format, "wb") as f:
                 f.write(data)
 
 
-def get_fic_with_url(url=None, format_type=0):
+def get_fic_with_url(url=None, format_type=0, out_dir="", debug=False):
+
+    with click.progressbar(label="Downloaded 1 file",  length=1) as bar:
+        fic_name, file_format, data = get_fic_data(url, format_type)
+
+        if debug:
+            logger.debug(f"Downloading 1/1: {fic_name}")
 
-    with click.progressbar(label="Downloading 1 file",  length=1) as bar:
-        file_name, data = get_fic_data(url, format_type)
-        with open(file_name, "wb") as f:
+        with open(out_dir+fic_name+file_format, "wb") as f:
             f.write(data)
             bar.update(2)