Custom formatting names (#53)

Author: subdavis

README.md

@@ -132,6 +132,7 @@ General usage
 ~$ kobodl book get \
   --user [email protected] \
   --output-dir /path/to/download_directory \
+  --format-str '{Title}' \
   c1db3f5c-82da-4dda-9d81-fa718d5d1d16
 
 # Download ALL books with default options when only 1 user exists
@@ -141,6 +142,7 @@ General usage
 ~$ kobodl book get \
   --user [email protected] \
   --output-dir /path/to/download_directory \
+  --format-str '{Title}' \
   --get-all
 ```
 

kobodl/actions.py

@@ -1,5 +1,6 @@
 import json
 import os
+import platform
 from typing import List, TextIO, Tuple, Union
 
 import click
@@ -32,29 +33,34 @@ def __GetBookAuthor(book: dict) -> str:
     return ' & '.join(authors)
 
 
-def __SanitizeFileName(fileName: str) -> str:
+def __SanitizeString(string: str) -> str:
     result = ''
-    for c in fileName:
+    for c in string:
         if c.isalnum() or ' ,;.!(){}[]#$\'-+@_'.find(c) >= 0:
             result += c
 
     result = result.strip(' .')
-    result = result[
-        :100
-    ]  # Limit the length -- mostly because of Windows. It would be better to do it on the full path using MAX_PATH.
+    if platform.system() == 'Windows':
+        # Limit the length -- mostly because of Windows. It would be better to do it on the full path using MAX_PATH.
+        result = result[:100]
     return result
 
 
-def __MakeFileNameForBook(bookMetadata: dict) -> str:
+def __MakeFileNameForBook(bookMetadata: dict, formatStr: str) -> str:
     '''filename without extension'''
     fileName = ''
-    author = __GetBookAuthor(bookMetadata)
-    if len(author) > 0:
-        fileName = author + ' - '
-    fileName += bookMetadata['Title']
-    fileName = __SanitizeFileName(fileName)
-    # Append a portion of revisionId to prevent name collisions.
-    return f"{fileName} {bookMetadata['RevisionId'][:8]}"
+    author = __SanitizeString(__GetBookAuthor(bookMetadata))
+    title = __SanitizeString(bookMetadata['Title'])
+
+    return formatStr.format_map(
+        {
+            **bookMetadata,
+            'Author': author,
+            'Title': title,
+            # Append a portion of revisionId to prevent name collisions.
+            'ShortRevisionId': bookMetadata['RevisionId'][:8],
+        }
+    )
 
 
 def __GetBookMetadata(entitlement: dict) -> Tuple[dict, BookType]:
@@ -163,7 +169,12 @@ def Login(user: User, password: str, captcha: str) -> None:
     kobo.Login(user.Email, password, captcha)
 
 
-def GetBookOrBooks(user: User, outputPath: str, productId: str = '') -> Union[None, str]:
+def GetBookOrBooks(
+    user: User,
+    outputPath: str,
+    formatStr: str = r'{Author} - {Title} {ShortRevisionId}',
+    productId: str = '',
+) -> Union[None, str]:
     """
     download 1 or all books to file
     returns output filepath if identifier is passed, otherwise returns None
@@ -192,7 +203,7 @@ def GetBookOrBooks(user: User, outputPath: str, productId: str = '') -> Union[No
             click.echo('Skipping subscribtion entity')
             continue
 
-        fileName = __MakeFileNameForBook(bookMetadata)
+        fileName = __MakeFileNameForBook(bookMetadata, formatStr)
         if book_type == BookType.EBOOK:
             # Audiobooks go in sub-directories
             # but epub files go directly in outputPath

kobodl/commands/book.py

@@ -1,4 +1,6 @@
 import os
+from pathlib import Path
+from typing import List
 
 import click
 from tabulate import tabulate
@@ -33,11 +35,19 @@ def book():
     '--output-dir',
     type=click.Path(file_okay=False, dir_okay=True, writable=True),
     default='kobo_downloads',
+    help='default: kobo_downloads',
 )
 @click.option('-a', '--get-all', is_flag=True)
+@click.option(
+    '-f',
+    '--format-str',
+    type=click.STRING,
+    default=r'{Author} - {Title} {ShortRevisionId}',
+    help=r"default: '{Author} - {Title} {ShortRevisionId}'",
+)
 @click.argument('product-id', nargs=-1, type=click.STRING)
 @click.pass_obj
-def get(ctx, user, output_dir, get_all, product_id):
+def get(ctx, user, output_dir: Path, get_all: bool, format_str: str, product_id: List[str]):
     if len(Globals.Settings.UserList.users) == 0:
         click.echo('error: no users found.  Did you `kobodl user add`?', err=True)
         exit(1)
@@ -67,10 +77,10 @@ def get(ctx, user, output_dir, get_all, product_id):
 
     os.makedirs(output_dir, exist_ok=True)
     if get_all:
-        actions.GetBookOrBooks(usercls, output_dir)
+        actions.GetBookOrBooks(usercls, output_dir, formatStr=format_str)
     else:
         for pid in product_id:
-            output = actions.GetBookOrBooks(usercls, output_dir, productId=pid)
+            actions.GetBookOrBooks(usercls, output_dir, formatStr=format_str, productId=pid)
 
 
 @book.command(name='list', help='list books')

setup.py

@@ -9,7 +9,7 @@
 setup(
     name='kobodl',
     author='Brandon Davis',
-    version='0.7.2',
+    version='0.7.3',
     author_email='[email protected]',
     url="https://github.com/subdavis/kobo-book-downloader",
     long_description=long_description,