Metadata-Version: 2.1
Name: pwebarc-dumb-dump-server
Version: 1.6.0
Summary: A very simple archiving server for pWebArc extension of Private Passive Web Archive (pwebarc) project
Author-email: Jan Malakhovski <oxij@oxij.org>
License: GPL-3.0-or-later
Project-URL: Homepage, https://oxij.org/software/pwebarc/
Project-URL: GitHub, https://github.com/Own-Data-Privateer/pwebarc
Keywords: HTTP,HTTPS,archive,wayback machine,download
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: System :: Archiving
Classifier: Topic :: System :: Archiving :: Backup
Classifier: Topic :: System :: Archiving :: Mirroring
Classifier: Topic :: System :: Logging
Classifier: Topic :: Internet :: Log Analysis
Classifier: Operating System :: POSIX
Classifier: Environment :: Console
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: cbor

# What is `pwebarc-dumb-dump-server`?

`pwebarc_dumb_dump_server.py`: a very ~~dumb~~ simple archiving server for [Personal Private Passive Web Archive (pwebarc)](https://github.com/Own-Data-Privateer/pwebarc/) (also [there](https://oxij.org/software/pwebarc/)) [pWebArc browser extension](https://github.com/Own-Data-Privateer/pwebarc/tree/master/extension/) (also [there](https://oxij.org/software/pwebarc/tree/master/extension/)).
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](https://github.com/Own-Data-Privateer/pwebarc/tree/master/README.md#quickstart) (also [there](https://oxij.org/software/pwebarc/tree/master/README.md#quickstart)).

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:
  ``` {.bash}
  ./pwebarc_dumb_dump_server.py --help
  ```
- Alternatively, install with:
  ``` {.bash}
  pip install pwebarc-dumb-dump-server
  ```
  and run as
  ``` {.bash}
  pwebarc-dumb-dump-server --help
  ```
- Alternatively, install it via Nix
  ``` {.bash}
  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

```
