mirrors/ArchiveBox
1
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2025-05-14 07:04:27 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

update docstrings and comments

Browse source
This commit is contained in:
Nick Sweeting 2019-04-22 14:42:04 -04:00
parent ab68819332
commit 2f0dbeebc1
4 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
archivebox/cli/__init__.py
View file

@ -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')

5
archivebox/cli/archivebox_help.py
View file

@ -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

2
archivebox/cli/archivebox_schedule.py
View file

@ -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

2
archivebox/legacy/main.py
View file

@ -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))