Skip to main content

A very simple archiving server for pWebArc extension of Private Passive Web Archive (pwebarc) project

Project description

What is pwebarc-dumb-dump-server?

pwebarc_dumb_dump_server.py: a very dumb simple archiving server for Personal Private Passive Web Archive (pwebarc) (also there) pWebArc browser extension (also there). This thing is less than 200 lines of pure Python that only uses the Python's standard library and nothing else. You could be running it already.

Why does pwebarc-dumb-dump-server exists?

This was made for easy Quickstart (also there).

Normally, you would use something smarter than this (when I publish it), but this will work fine as a starting point.

Also, even with the better thing, this is still useful in case you are feeling paranoid and only want to run the minimal viable thing as a daemon.

Quickstart

Installation

  • You can run this without installing:
    ./pwebarc_dumb_dump_server.py --help
    
  • Alternatively, install with:
    pip install pwebarc-dumb-dump-server
    
    and run as
    pwebarc-dumb-dump-server --help
    
  • Alternatively, install it via Nix
    nix-env -i -f ./default.nix
    pwebarc-dumb-dump-server --help
    

Usage

usage: pwebarc_dumb_dump_server.py [-h] [--version] [--host HOST] [--port PORT] [--root ROOT] [--uncompressed] [--default-profile NAME] [--ignore-profiles] [--no-print-cbors]

Simple archiving server for pWebArc. Dumps each request to `<ROOT>/<profile>/<year>/<month>/<day>/<epoch>_<number>.wrr`.

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --host HOST           listen on what host/IP (default: 127.0.0.1)
  --port PORT           listen on what port (default: 3210)
  --root ROOT           path to dump data into (default: pwebarc-dump)
  --uncompressed        dump new archivals to disk without compression; the default is to try to compress each new archive first
  --default-profile NAME
                        default profile to use when no `profile` query parameter is supplied by the extension (default: `default`)
  --ignore-profiles     ignore `profile` query parameter supplied by the extension and use the value of `--default-profile` instead
  --no-print-cbors      don't print parsed representations of newly archived CBORs to stdout even if `cbor2` module is available

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pwebarc-dumb-dump-server-1.6.0.tar.gz (5.2 kB view hashes)

Uploaded Source

Built Distribution

pwebarc_dumb_dump_server-1.6.0-py3-none-any.whl (5.8 kB view hashes)

Uploaded Python 3

Supported by

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