A backend toolkit for management of WebScrapBook collection.
Project description
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 isC
, an additional commandD:
is requied besidescd D:\path\to\scrapbook
.You can also use the shortcurt:
Shift + Right-click
on a folder and selectOpen 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
Project details
Release history Release notifications | RSS feed
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
Hashes for webscrapbook-0.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e24f7e61825f892c44ddc1e8919b0c10c60ce974879b859ec27bd426386518d4 |
|
MD5 | 19238923f815406ffc82905122b250ac |
|
BLAKE2b-256 | 624f1561258ed88b5b607cb7e493e70dea556592e0ef7bfb014f247d7e4b288b |