Simple archiving server for the `Hoardy-Web` Web Extension browser add-on.
Project description
What is hoardy-web-sas
?
hoardy-web-sas
is a very simple archiving server for the Hoardy-Web
Web Extension browser add-on (also there).
I.e. this is the thing you run and then paste the URL of into the Server URL
setting of the Hoardy-Web
add-on.
This thing is less than 250 lines of pure Python that only uses the Python's standard library and nothing else. You could be running it already.
Why does hoardy-web-sas
exists?
This was made for easy Quickstart (also there) that also does reliable archiving.
Quickstart
Pre-installation
-
Install
Python 3
:- On Windows: Download and install Python from the official website.
- On a conventional POSIX system like most GNU/Linux distros and MacOS X: Install
python3
via your package manager. Realistically, it probably is installed already.
Installation
-
On a Windows system with unconfigured
PATH
, install with:pip install hoardy-web-sas
and run as
python3 -m hoardy_web_sas --help
-
On a conventional POSIX system or on a Windows system with configured
PATH
environment variable, install it with:pip install hoardy-web-sas
and run as
hoardy-web-sas --help
-
Alternatively, run without installing:
./hoardy-web-sas.py --help
-
Alternatively, on a system with Nix package manager
nix-env -i -f ./default.nix hoardy-web-sas --help
Though, in this case, you'll probably want to do the first command from the parent directory, to install everything all at once.
Usage
usage: hoardy_web_sas.py [-h] [--version] [--host HOST] [--port PORT] [--root ROOT] [--uncompressed] [--default-bucket NAME] [--ignore-buckets] [--no-print]
Simple archiving server for Hoardy-Web. 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-bucket NAME, --default-profile NAME
default bucket to use when no `profile` query parameter is supplied by the extension (default: `default`)
--ignore-buckets, --ignore-profiles
ignore `profile` query parameter supplied by the extension and use the value of `--default-bucket` instead
--no-print, --no-print-cbors
don't print parsed representations of newly archived CBORs to stdout even if `cbor2` module is available
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 hoardy_web_sas-1.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 989f64137e0704f8cbcf091913ebb4885731e04803ca832c4b645502c4d5455e |
|
MD5 | 1cac8474ab5c3d585dcfa185bd9d8d33 |
|
BLAKE2b-256 | da243d00fa31f60e3d934f583abd09b21fda789c6ec809bbbc01206133a15287 |