Update README to include scheduler

This commit is contained in:
Jon 2021-11-21 15:54:30 -05:00
parent 1c5ff79ef5
commit fd56f43682
No known key found for this signature in database
GPG key ID: 9665BA6CF5DC2671
2 changed files with 4 additions and 2 deletions

View file

@ -100,6 +100,8 @@ python qbit_manage.py -h
| Shell Command | Description | Default Value | | Shell Command | Description | Default Value |
| :------------ | :------------ | :------------ | | :------------ | :------------ | :------------ |
| `--run` | Run without the scheduler. Script will exit after completion. | False |
| `-sch` or `--schedule` | Schedule to run every x minutes. (Default set to 30) | 30 |
| `-c CONFIG` or `--config-file CONFIG` | This is used if you want to use a different name for your config.yml. `Example: tv.yml` | config.yml | | `-c CONFIG` or `--config-file CONFIG` | This is used if you want to use a different name for your config.yml. `Example: tv.yml` | config.yml |
| `-l LOGFILE,` or `--log-file LOGFILE,` | This is used if you want to use a different name for your log file. `Example: tv.log` | activity.log | | `-l LOGFILE,` or `--log-file LOGFILE,` | This is used if you want to use a different name for your log file. `Example: tv.log` | activity.log |
| `-m` or `--manage` | Use this if you would like to update your tags, categories, remove unregistered torrents, recheck/resume paused torrents, and empty recycle bin. | | | `-m` or `--manage` | Use this if you would like to update your tags, categories, remove unregistered torrents, recheck/resume paused torrents, and empty recycle bin. | |

View file

@ -23,7 +23,7 @@ if sys.version_info[0] != 3 or sys.version_info[1] < 6:
parser = argparse.ArgumentParser('qBittorrent Manager.', parser = argparse.ArgumentParser('qBittorrent Manager.',
description='A mix of scripts combined for managing qBittorrent.') description='A mix of scripts combined for managing qBittorrent.')
parser.add_argument("--run", dest="run", help="Run without the scheduler", action="store_true", default=False) parser.add_argument("--run", dest="run", help="Run without the scheduler. Script will exit after completion.", action="store_true", default=False)
parser.add_argument("-sch", "--schedule", dest="sch", help="Schedule to run every x minutes. (Default set to 30)", default=30, type=int) parser.add_argument("-sch", "--schedule", dest="sch", help="Schedule to run every x minutes. (Default set to 30)", default=30, type=int)
parser.add_argument('-c', '--config-file', parser.add_argument('-c', '--config-file',
dest='config', dest='config',
@ -855,7 +855,7 @@ if __name__ == '__main__':
logger.info(f" Version: {version}") logger.info(f" Version: {version}")
try: try:
if run: if run:
logger.info(f" Run Mode: Script will exit after one run.") logger.info(f" Run Mode: Script will exit after completion.")
start() start()
else: else:
schedule.every(sch).minutes.do(start) schedule.every(sch).minutes.do(start)