hoardy-web-sas


Namehoardy-web-sas JSON
Version 1.7.0 PyPI version JSON
download
home_pageNone
SummarySimple archiving server for the `Hoardy-Web` Web Extension browser add-on.
upload_time2024-10-07 13:54:45
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseGPL-3.0-or-later
keywords http https www web browser site website download archive mirror wayback wayback machine
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # What is `hoardy-web-sas`?

`hoardy-web-sas` is a very simple archiving server for [the `Hoardy-Web` Web Extension browser add-on](https://github.com/Own-Data-Privateer/hoardy-web/tree/master/extension/) (also [there](https://oxij.org/software/hoardy-web/tree/master/extension/)).

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](https://github.com/Own-Data-Privateer/hoardy-web/tree/master/README.md#quickstart) (also [there](https://oxij.org/software/hoardy-web/tree/master/README.md#quickstart)) that also [does reliable archiving](https://oxij.org/software/hoardy-web/tree/master/extension/page/help.org#faq-unsafe).

# Quickstart

## Pre-installation

- Install `Python 3`:

  - On Windows: [Download and install Python from the official website](https://www.python.org/downloads/windows/).
  - 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:

  ``` bash
  pip install hoardy-web-sas
  ```
  and run as
  ``` bash
  python3 -m hoardy_web_sas --help
  ```

- On a conventional POSIX system or on a Windows system with configured `PATH` environment variable, install it with:

  ``` bash
  pip install hoardy-web-sas
  ```
  and run as
  ``` bash
  hoardy-web-sas --help
  ```

- Alternatively, run without installing:

  ``` {.bash}
  ./hoardy-web-sas.py --help
  ```

- Alternatively, on a system with [Nix package manager](https://nixos.org/nix/)

  ``` {.bash}
  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

```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "hoardy-web-sas",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "HTTP, HTTPS, WWW, web, browser, site, website, download, archive, mirror, wayback, wayback machine",
    "author": null,
    "author_email": "Jan Malakhovski <oxij@oxij.org>",
    "download_url": "https://files.pythonhosted.org/packages/ea/7d/e23daeae793b3930d8e5708df6dcf17e18ad778cbb14986e3898d2e46985/hoardy-web-sas-1.7.0.tar.gz",
    "platform": null,
    "description": "# What is `hoardy-web-sas`?\n\n`hoardy-web-sas` is a very simple archiving server for [the `Hoardy-Web` Web Extension browser add-on](https://github.com/Own-Data-Privateer/hoardy-web/tree/master/extension/) (also [there](https://oxij.org/software/hoardy-web/tree/master/extension/)).\n\nI.e. this is the thing you run and then paste the URL of into the `Server URL` setting of the `Hoardy-Web` add-on.\n\nThis thing is less than 250 lines of pure Python that only uses the Python\\'s standard library and nothing else.\nYou could be running it already.\n\n# Why does `hoardy-web-sas` exists?\n\nThis was made for easy [Quickstart](https://github.com/Own-Data-Privateer/hoardy-web/tree/master/README.md#quickstart) (also [there](https://oxij.org/software/hoardy-web/tree/master/README.md#quickstart)) that also [does reliable archiving](https://oxij.org/software/hoardy-web/tree/master/extension/page/help.org#faq-unsafe).\n\n# Quickstart\n\n## Pre-installation\n\n- Install `Python 3`:\n\n  - On Windows: [Download and install Python from the official website](https://www.python.org/downloads/windows/).\n  - 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.\n\n## Installation\n\n- On a Windows system with unconfigured `PATH`, install with:\n\n  ``` bash\n  pip install hoardy-web-sas\n  ```\n  and run as\n  ``` bash\n  python3 -m hoardy_web_sas --help\n  ```\n\n- On a conventional POSIX system or on a Windows system with configured `PATH` environment variable, install it with:\n\n  ``` bash\n  pip install hoardy-web-sas\n  ```\n  and run as\n  ``` bash\n  hoardy-web-sas --help\n  ```\n\n- Alternatively, run without installing:\n\n  ``` {.bash}\n  ./hoardy-web-sas.py --help\n  ```\n\n- Alternatively, on a system with [Nix package manager](https://nixos.org/nix/)\n\n  ``` {.bash}\n  nix-env -i -f ./default.nix\n  hoardy-web-sas --help\n  ```\n\n  Though, in this case, you'll probably want to do the first command from the parent directory, to install everything all at once.\n\n# Usage\n\n```\nusage: hoardy_web_sas.py [-h] [--version] [--host HOST] [--port PORT] [--root ROOT] [--uncompressed] [--default-bucket NAME] [--ignore-buckets] [--no-print]\n\nSimple archiving server for Hoardy-Web. Dumps each request to `<ROOT>/<profile>/<year>/<month>/<day>/<epoch>_<number>.wrr`.\n\noptions:\n  -h, --help            show this help message and exit\n  --version             show program's version number and exit\n  --host HOST           listen on what host/IP (default: 127.0.0.1)\n  --port PORT           listen on what port (default: 3210)\n  --root ROOT           path to dump data into (default: pwebarc-dump)\n  --uncompressed        dump new archivals to disk without compression; the default is to try to compress each new archive first\n  --default-bucket NAME, --default-profile NAME\n                        default bucket to use when no `profile` query parameter is supplied by the extension (default: `default`)\n  --ignore-buckets, --ignore-profiles\n                        ignore `profile` query parameter supplied by the extension and use the value of `--default-bucket` instead\n  --no-print, --no-print-cbors\n                        don't print parsed representations of newly archived CBORs to stdout even if `cbor2` module is available\n\n```\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-or-later",
    "summary": "Simple archiving server for the `Hoardy-Web` Web Extension browser add-on.",
    "version": "1.7.0",
    "project_urls": {
        "GitHub": "https://github.com/Own-Data-Privateer/hoardy-web",
        "Homepage": "https://oxij.org/software/hoardy-web/",
        "Support Development": "https://oxij.org/#support"
    },
    "split_keywords": [
        "http",
        " https",
        " www",
        " web",
        " browser",
        " site",
        " website",
        " download",
        " archive",
        " mirror",
        " wayback",
        " wayback machine"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "da243d00fa31f60e3d934f583abd09b21fda789c6ec809bbbc01206133a15287",
                "md5": "1cac8474ab5c3d585dcfa185bd9d8d33",
                "sha256": "989f64137e0704f8cbcf091913ebb4885731e04803ca832c4b645502c4d5455e"
            },
            "downloads": -1,
            "filename": "hoardy_web_sas-1.7.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1cac8474ab5c3d585dcfa185bd9d8d33",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 6003,
            "upload_time": "2024-10-07T13:54:43",
            "upload_time_iso_8601": "2024-10-07T13:54:43.765064Z",
            "url": "https://files.pythonhosted.org/packages/da/24/3d00fa31f60e3d934f583abd09b21fda789c6ec809bbbc01206133a15287/hoardy_web_sas-1.7.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ea7de23daeae793b3930d8e5708df6dcf17e18ad778cbb14986e3898d2e46985",
                "md5": "889c4ab343dd8953b8559ce3efc54198",
                "sha256": "0c030a11ccfac04a7727b2cbc6a623e2fe8e4c92142560387b739c63b49f6126"
            },
            "downloads": -1,
            "filename": "hoardy-web-sas-1.7.0.tar.gz",
            "has_sig": false,
            "md5_digest": "889c4ab343dd8953b8559ce3efc54198",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 5583,
            "upload_time": "2024-10-07T13:54:45",
            "upload_time_iso_8601": "2024-10-07T13:54:45.354896Z",
            "url": "https://files.pythonhosted.org/packages/ea/7d/e23daeae793b3930d8e5708df6dcf17e18ad778cbb14986e3898d2e46985/hoardy-web-sas-1.7.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-07 13:54:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Own-Data-Privateer",
    "github_project": "hoardy-web",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "hoardy-web-sas"
}
        
Elapsed time: 0.80636s