hiro/kindle_fetch
1
0
Fork 0
mirror of https://github.com/vale981/kindle_fetch synced 2025-03-04 16:41:38 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

make help formatting more consistent

Browse source
This commit is contained in:
Valentin Boettcher 2024-11-17 13:24:33 -05:00
parent 5ad0541854
commit e481817dc6
No known key found for this signature in database
GPG key ID: E034E12B7AF56ACE
2 changed files with 14 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -15,21 +15,24 @@ OUTDIR/.latest.pdf` to have the latest kindle PDF visible.
Either clone this repo and use `poerty install` and the like or run the nix flake with `nix run github:vale981/kindle_fetch -- [args]`. Either clone this repo and use `poerty install` and the like or run the nix flake with `nix run github:vale981/kindle_fetch -- [args]`.
``` ```
usage: kindle_fetch [-h] [--outdir OUTDIR] [--current_file CURRENT_FILE] [--imap_folder IMAP_FOLDER] [--loglevel LOGLEVEL] server user pass_command usage: kindle_fetch [-h] [--outdir OUTDIR] [--current_file CURRENT_FILE] [--imap_folder IMAP_FOLDER]
[--loglevel LOGLEVEL]
server user pass_command
Monitors you email and automatically downloads the kindle PDF notes sent to it. Monitors you email and automatically downloads the kindle PDF notes sent to it.
positional arguments: positional arguments:
server the IMAP server to connect to server the IMAP server to connect to
user the IMAP username user the IMAP username
pass_command A shell command that returns the password to the server. pass_command a shell command that returns the password to the server
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--outdir OUTDIR The kindle note PDFs will be saved into `OUTDIR/[name].pdf`. (default: ~/kindle_dump) --outdir OUTDIR the kindle note PDFs will be saved into `OUTDIR/[name].pdf` (default: ~/kindle_dump)
--current_file CURRENT_FILE --current_file CURRENT_FILE
The latest downloaded file will be copied to `OUTDIR/[current_file] (default: .latest.pdf) the latest downloaded file will be copied to `OUTDIR/[current_file] (default:
.latest.pdf)
--imap_folder IMAP_FOLDER --imap_folder IMAP_FOLDER
The IMAP folder to monitor for new messages. (default: INBOX) the IMAP folder to monitor for new messages (default: INBOX)
--loglevel LOGLEVEL The python logging level to use. (default: info) --loglevel LOGLEVEL the python logging level to use (default: info)
``` ```

10
kindle_fetch/kindle_fetch.py
View file

@ -168,30 +168,30 @@ def parse_args_and_configure_logging():
parser.add_argument( parser.add_argument(
"pass_command", "pass_command",
type=str, type=str,
help="A shell command that returns the password to the server.", help="a shell command that returns the password to the server",
) )
parser.add_argument( parser.add_argument(
"--outdir", "--outdir",
type=str, type=str,
help="The kindle note PDFs will be saved into `OUTDIR/[name].pdf`.", help="the kindle note PDFs will be saved into `OUTDIR/[name].pdf`",
default="~/kindle_dump", default="~/kindle_dump",
) )
parser.add_argument( parser.add_argument(
"--current_file", "--current_file",
type=str, type=str,
help="The latest downloaded file will be copied to `OUTDIR/[current_file]", help="the latest downloaded file will be copied to `OUTDIR/[current_file]",
default=".latest.pdf", default=".latest.pdf",
) )
parser.add_argument( parser.add_argument(
"--imap_folder", "--imap_folder",
type=str, type=str,
help="The IMAP folder to monitor for new messages.", help="the IMAP folder to monitor for new messages",
default="INBOX", default="INBOX",
) )
parser.add_argument( parser.add_argument(
"--loglevel", "--loglevel",
default="info", default="info",
help="The python logging level to use.", help="the python logging level to use",
) )
args = parser.parse_args() args = parser.parse_args()