Metadata-Version: 2.1
Name: webscrapbook
Version: 0.16.3
Summary: A backend toolkit for management of WebScrapBook collection.
Home-page: https://github.com/danny0838/PyWebScrapBook
Author: Danny Lin
Author-email: danny0838@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Natural Language :: English
Classifier: Topic :: Database
Classifier: Topic :: Internet
Requires-Python: ~=3.5
Description-Content-Type: text/markdown
Requires-Dist: flask (>=1.1)
Requires-Dist: werkzeug
Requires-Dist: jinja2
Requires-Dist: cryptography
Requires-Dist: lxml (>=4.0)
Requires-Dist: commonmark (>=0.8)

PyWebScrapBook is a command line toolkit and backend server for
[WebScrapBook browser extension](https://github.com/danny0838/webscrapbook).

## 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](https://www.python.org).

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 is `C`, an additional command `D:` is requied besides `cd D:\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](https://github.com/danny0838/webscrapbook/wiki/Backend) for more details.

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 help about available commands:

    wsb --help

For documentation about configs, run:

    wsb help config

For more useful ways to configure PyWebScrapBook alongside WebScrapBook, visit the documentation wiki for [WebScrapBook](https://github.com/danny0838/webscrapbook/wiki/Backend).


