Explorar el Código

update docstrings and comments

Nick Sweeting hace 6 años
padre
commit
2f0dbeebc1

+ 1 - 1
archivebox/cli/__init__.py

@@ -8,7 +8,7 @@ from importlib import import_module
 CLI_DIR = os.path.dirname(os.path.abspath(__file__))
 CLI_DIR = os.path.dirname(os.path.abspath(__file__))
 
 
 # these common commands will appear sorted before any others for ease-of-use
 # these common commands will appear sorted before any others for ease-of-use
-display_first = ('help', 'version', 'init', 'list', 'update', 'add', 'remove')
+display_first = ('help', 'version', 'init', 'info', 'list', 'update', 'add', 'remove')
 
 
 # every imported command module must have these properties in order to be valid
 # every imported command module must have these properties in order to be valid
 required_attrs = ('__package__', '__command__', 'main')
 required_attrs = ('__package__', '__command__', 'main')

+ 3 - 2
archivebox/cli/archivebox_help.py

@@ -40,13 +40,14 @@ def main(args=None):
 {lightblue}Example Use:{reset}
 {lightblue}Example Use:{reset}
     mkdir my-archive; cd my-archive/
     mkdir my-archive; cd my-archive/
     archivebox init
     archivebox init
+    archivebox info
 
 
     archivebox add https://example.com/some/page
     archivebox add https://example.com/some/page
     archivebox add --depth=1 ~/Downloads/bookmarks_export.html
     archivebox add --depth=1 ~/Downloads/bookmarks_export.html
     
     
-    archivebox subscribe https://example.com/some/feed.rss
-    archivebox update --resume=15109948213.123
     archivebox list --sort=timestamp --csv=timestamp,url,is_archived
     archivebox list --sort=timestamp --csv=timestamp,url,is_archived
+    archivebox schedule --every=week https://example.com/some/feed.rss
+    archivebox update --resume=15109948213.123
 
 
 {lightblue}Documentation:{reset}
 {lightblue}Documentation:{reset}
     https://github.com/pirate/ArchiveBox/wiki
     https://github.com/pirate/ArchiveBox/wiki

+ 1 - 1
archivebox/cli/archivebox_schedule.py

@@ -2,7 +2,7 @@
 
 
 __package__ = 'archivebox.cli'
 __package__ = 'archivebox.cli'
 __command__ = 'archivebox schedule'
 __command__ = 'archivebox schedule'
-__description__ = 'Set ArchiveBox to run regularly at a specific time'
+__description__ = 'Set ArchiveBox to regularly import URLs at specific times using cron'
 
 
 import os
 import os
 import sys
 import sys

+ 1 - 1
archivebox/legacy/main.py

@@ -133,7 +133,7 @@ def info():
     
     
     num_bytes, num_dirs, num_files = get_dir_size(OUTPUT_DIR, recursive=False)
     num_bytes, num_dirs, num_files = get_dir_size(OUTPUT_DIR, recursive=False)
     size = human_readable_size(num_bytes)
     size = human_readable_size(num_bytes)
-    print(f'    > Index Size: {size} across {num_files} files in')
+    print(f'    > Index Size: {size} across {num_files} files')
     print()
     print()
 
 
     print('{green}[*] Scanning archive collection data directory with {} entries:{reset}'.format(len(all_links), **ANSI))
     print('{green}[*] Scanning archive collection data directory with {} entries:{reset}'.format(len(all_links), **ANSI))