PyWebScrapBook is a command line toolkit and backend server for WebScrapBook browser extension.
Features
- 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.
Usage
Installation
Install from the package manager
-
Install Python >= 3.8 from the official site.
Add python to
PATHenvironment 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 webscrapbookAfter installation,
wsbwill be available from the CLI.
Install from compiled binary
-
Download the binary package compatible with your system from the latest release, and unzip to anywhere on your device.
-
Optionally add the parent directory of the executable file to
PATHenvironment variable so that it can be run from the CLI more easily.
Usage overview
Run wsb --help for 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)
Run wsb <command> --help for help about <command>. For example, wsb config --help for help about wsb config.
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 or parameter to change drive may be required. For example, if the directory to host is
E:\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 -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:
wsb serve
Alternatively, 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)
The wsb executable also supports opening an archive page (HTZ or MAFF) to view in the browser.
Run which wsb (or where wsb in 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.
Configuration
Run wsb config -be to edit configs for CWD. For documentation about configs, run wsb help config, or read it online.
Further documentation
For more tips about how to configure PyWebScrapBook alongside WebScrapBook, visit the documentation wiki for WebScrapBook.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file webscrapbook-2.10.1.tar.gz.
File metadata
- Download URL: webscrapbook-2.10.1.tar.gz
- Upload date:
- Size: 182.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
967703c6821df3164a46a2241627aa784fc64f91ddd11056a3698ef9d8dbf4f8
|
|
| MD5 |
7a2721b9d6451d2a25a7e5a59eeda67d
|
|
| BLAKE2b-256 |
42e53a784470177ac610030bf30d78b213b4f082c4bfd7189b1dc63bbb573ea1
|
File details
Details for the file webscrapbook-2.10.1-py3-none-any.whl.
File metadata
- Download URL: webscrapbook-2.10.1-py3-none-any.whl
- Upload date:
- Size: 216.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ffbb627497e70b189b1cc75c303116ce98555248e5d470d48d99cd9e0591559e
|
|
| MD5 |
dd87a6c78fbcb3675f2f17f1e728fcd0
|
|
| BLAKE2b-256 |
9c0ab8afe4917e86593e60e8842bb6a3c0164b781d3469d4b744a3a0c48b3a9c
|
