A backend toolkit for management of WebScrapBook collection.
PyWebScrapBook is a command line toolkit and backend server for WebScrapBook browser extension.
- Host 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.
Install Python >= 3.6 from the official site.
Add python to
PATH environment variable 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
wsbview will be available from the CLI.
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 help show detailed information about certain topics view view archive file in the browser optional arguments: -h, --help show this help message and exit --version show version information and exit --root ROOT root directory to manipulate (default: current working directory)
Host a scrapbook
Switch current working directory (CWD) to a directory you'd like to host.
In Windows, an additional command to change drive might be required. For example, if the directory to host is
D:\path\to\scrapbookwhile the current drive is
C, an additional command
D:is requied besides
You can also use the shortcurt:
Shift + Right-clickon the desired folder and select
Open command window hereor
Open PowerShell window here.
Generate config files for the directory:
wsb config -ba
This step can be skipped if you want PyWebScrapBook default data structure instead. See doc wiki for more details.
Run the generated
.wsb/serve.py to start the server, or run below command from CLI:
Open archive file directly
wsbview executable supports opening an archive page (HTZ or MAFF) to view in the browser.
which wsbview (or
where wsbview in Windows) from CLI to get the path of
wsbview executable, and set default application of MAFF/HTZ file to that executable to open them directly in the browser with double-click.
Run below command for help about available commands:
For documentation about configs, run:
wsb help config
or read online.
For more useful ways to configure PyWebScrapBook alongside WebScrapBook, visit the documentation wiki for WebScrapBook.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size webscrapbook-0.27.1-py3-none-any.whl (124.0 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size webscrapbook-0.27.1.tar.gz (164.8 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for webscrapbook-0.27.1-py3-none-any.whl