PyWebScrapBook is a command line toolkit and backend server for WebScrapBook browser extension.

Features

• Host any directory as a website.
• HTZ or MAFF archive file viewing.
• Markdown file rendering.
• Directory listing.
• Create, view, edit, and/or delete files via the web page or API.
• HTTP(S) authorization.

Usage

Install Python

Install Python >= 3.5 from the official site.

Add python to PATH so that it can be run from the command line interface (CLI).

Install this package

Run below command from CLI to install (or upgrade to) the latest version:

python -m pip install -U webscrapbook

After installation, wsb or webscrapbook will be available from the CLI.

Host a scrapbook

Switch current working directory (CWD) to a directory you'd like to host.

cd /path/to/scrapbook

In Windows, an additional command to change drive might be required. For example, if the directory to host is D:\path\to\scrapbook while the current drive is C, an additional command D: is requied besides cd D:\path\to\scrapbook.

You can also use the shortcurt: Shift + Right-click on a folder and select Open command window here.

Generate config files for the directory:

wsb config -ba

Run .wsb/serve.py to start the server, or run below command from CLI:

wsb serve

Open archive file directly

Run which wsbview (or where wsbview in Windows) from CLI to get the command path. Set default application of MAFF/HTZ file to the command at that path to open them directly in the browser with double-click.

Further documentation

Run below command for further help:

wsb --help