Package: webscrapbook
PyWebScrapBook is a command line toolkit and backend server forWebScrapBook browser extension.FeaturesHost any directory(s) as website(s).Directory listing.HTZ or MAFF archive file viewing.Markdown file rendering.Create, view, edit, and/or delete files via the web interface or API.HTTP(S) authorization and simple ACL.Tools for scrapbooks management, such as cache generating and data checking, exporting, importing, and conversion.UsageInstall PythonInstall Python >= 3.7 from theofficial site.Add python toPATHenvironment variable so that it can be run from the command line interface (CLI).Install this packageRun below command from CLI to install (or upgrade to) the latest version:python -m pip install -U webscrapbookAfter installation,wsbwill be available from the CLI.Usage overviewRunwsb --helpfor help about available commands, which looks like:usage: wsb [-h] [--version] [--root ROOT] COMMAND ...

positional arguments:
  COMMAND      the sub-command to run. Get usage help with e.g. wsb config -h
    serve (s)  serve the root directory
    config (c)
               show, generate, or edit the config
    encrypt (e)
               generate an encrypted password
    cache (a)  update fulltext cache and/or static site pages
    check (k)  check and fix scrapbook data
    export (x)
               export data items into archive files (*.wsba)
    import (i)
               import data items from archive files (*.wsba)
    convert (v)
               convert scrapbook data between different formats
    query (q)  perform queries on the scrapbook(s)
    search (r)
               search for data items in the scrapbook(s)
    help       show detailed information about certain topics
    view       view archive file in the browser

options:
  -h, --help   show this help message and exit
  --version    show version information and exit
  --root ROOT  root directory to manipulate (default: current working directory)Runwsb <command> --helpfor help about<command>. For example,wsb config --helpfor help aboutwsb config.Host a scrapbookSwitch current working directory (CWD) to a directory you'd like to host.cd /path/to/scrapbookIn Windows, an additional command or parameter to change drive may be required. For example, if the directory to host isE:\path\to\scrapbookwhile the current drive isC, an additional commandE:(or parameter/d) is required besidescd E:\path\to\scrapbook.You can also use the shortcurt:Shift + Right-clickon the desired folder and selectOpen command window hereorOpen PowerShell window here.Generate config files for the directory:wsb config -baThis step can be skipped if you want PyWebScrapBook default data structure instead. Seedoc wikifor more details.Run the generated.wsb/serve.pyto start the server, or run below command from CLI:wsb serveAlternatively, a backend server can be run with a specialized WSGI server, such as mod_wsgi, uWSGI, or Gunicorn, by providing the generated application script.wsb/app.pyto it.Open an archive file directly (optional)Thewsbexecutable also supports opening an archive page (HTZ or MAFF) to view in the browser.Runwhich wsb(orwhere wsbin Windows) from CLI to get the path of the executable, and set default application of MAFF/HTZ file to that executable to open them directly in the browser with double-click.ConfigurationRunwsb config -beto edit configs for CWD. For documentation about configs, runwsb help config, orread it online.Further documentationFor more tips about how to configure PyWebScrapBook alongside WebScrapBook, visitthe documentation wiki for WebScrapBook.