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:
python -m pip install 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
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.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb4db449aa3ed381fe8c17010769073aec199e96ad7ea8433e89998f93de095f |
|
MD5 | 711b9f103821a3c9129847738126fb1e |
|
BLAKE2b-256 | 37d407325b200e1fbac6ffc6b344b98f552b08c1f9961ae85913bafbc0bc8866 |