Skip to main content

A backend toolkit for management of WebScrapBook collection.

Project description

PyPI version Python Versions Docker Image Status License

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

  1. Install Python >= 3.7 from the official site.

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

  2. 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 will be available from the CLI.

Install from compiled binary

  1. Download the binary package compatible with your system from the latest release, and unzip to anywhere on your device.

  2. Optionally add the parent directory of the executable file to PATH environment 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\scrapbook while the current drive is C, an additional command E: (or parameter /d) is required besides cd E:\path\to\scrapbook.

You can also use the shortcurt: Shift + Right-click on the desired folder and select Open command window here or 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:

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.py to 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.

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

webscrapbook-2.6.1.tar.gz (178.6 kB view details)

Uploaded Source

Built Distribution

webscrapbook-2.6.1-py3-none-any.whl (213.1 kB view details)

Uploaded Python 3

File details

Details for the file webscrapbook-2.6.1.tar.gz.

File metadata

  • Download URL: webscrapbook-2.6.1.tar.gz
  • Upload date:
  • Size: 178.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for webscrapbook-2.6.1.tar.gz
Algorithm Hash digest
SHA256 4c8aa324ca00dca4c0d58d7148b7c3f8c24f980dddc20a1c44fb0997467d39ad
MD5 b15343fcb0d0b955c9c31afa96f9bd48
BLAKE2b-256 853f150b6f654490b6a7b6f66b4764730c335574e0cc105bd239ffd176ce6d83

See more details on using hashes here.

File details

Details for the file webscrapbook-2.6.1-py3-none-any.whl.

File metadata

  • Download URL: webscrapbook-2.6.1-py3-none-any.whl
  • Upload date:
  • Size: 213.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for webscrapbook-2.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 32b30b03a46304add690582af41c7a6ba96e15418121d7cb3b39e4cdf16350cc
MD5 644c588ec68df580017d52256803a854
BLAKE2b-256 0c70f6889166babda79a0f1cf0730f846fa749f1c832dee61c87dab09a4b9be6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page