pwebarc-dumb-dump-server


Namepwebarc-dumb-dump-server JSON
Version 1.5.5 PyPI version JSON
download
home_page
SummaryA very simple archiving server for pWebArc extension of Private Web Archive (pwebarc) project
upload_time2023-12-04 19:58:22
maintainer
docs_urlNone
author
requires_python>=3.7
licenseGPL-3.0-or-later
keywords http https archive wayback machine download
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # What?

`pwebarc_dumb_dump_server.py`: a very ~~dumb~~ simple archiving server for [Private Web Archive (pwebarc)](https://github.com/Own-Data-Privateer/pwebarc/) [pWebArc browser extension](https://github.com/Own-Data-Privateer/pwebarc/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?

This was made for easy [Quickstart](https://github.com/Own-Data-Privateer/README.md#quickstart).
Ideally, you would use something smarter than this (when I publish it), but this will work fine as a starting point.

# 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
  ```

# Usage

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

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)
  --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-cbor             don't load `cbor2` module, disables parsing of input
                        data
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "pwebarc-dumb-dump-server",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "HTTP,HTTPS,archive,wayback machine,download",
    "author": "",
    "author_email": "Jan Malakhovski <oxij@oxij.org>",
    "download_url": "https://files.pythonhosted.org/packages/08/e4/8ab2bfe37f227e6ab2b8d71c40501aa4995e77850c98057a97e8512c45b4/pwebarc-dumb-dump-server-1.5.5.tar.gz",
    "platform": null,
    "description": "# What?\n\n`pwebarc_dumb_dump_server.py`: a very ~~dumb~~ simple archiving server for [Private Web Archive (pwebarc)](https://github.com/Own-Data-Privateer/pwebarc/) [pWebArc browser extension](https://github.com/Own-Data-Privateer/pwebarc/extension/).\nThis thing is less than 200 lines of pure Python that only uses the Python\\'s standard library and nothing else.\nYou could be running it already.\n\n# Why?\n\nThis was made for easy [Quickstart](https://github.com/Own-Data-Privateer/README.md#quickstart).\nIdeally, you would use something smarter than this (when I publish it), but this will work fine as a starting point.\n\n# Quickstart\n\n## Installation\n\n- You can run this without installing:\n  ``` {.bash}\n  ./pwebarc_dumb_dump_server.py --help\n  ```\n- Alternatively, install with:\n  ``` {.bash}\n  pip install pwebarc-dumb-dump-server\n  ```\n  and run as\n  ``` {.bash}\n  pwebarc-dumb-dump-server --help\n  ```\n- Alternatively, install it via Nix\n  ``` {.bash}\n  nix-env -i -f ./default.nix\n  ```\n\n# Usage\n\n```\nusage: pwebarc_dumb_dump_server.py [-h] [--version] [--host HOST]\n                                   [--port PORT] [--root ROOT]\n                                   [--default-profile NAME]\n                                   [--ignore-profiles] [--no-cbor]\n\nSimple archiving server for pWebArc. Dumps each request to\n`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  --default-profile NAME\n                        default profile to use when no `profile` query\n                        parameter is supplied by the extension (default:\n                        `default`)\n  --ignore-profiles     ignore `profile` query parameter supplied by the\n                        extension and use the value of `--default-profile`\n                        instead\n  --no-cbor             don't load `cbor2` module, disables parsing of input\n                        data\n```\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-or-later",
    "summary": "A very simple archiving server for pWebArc extension of Private Web Archive (pwebarc) project",
    "version": "1.5.5",
    "project_urls": null,
    "split_keywords": [
        "http",
        "https",
        "archive",
        "wayback machine",
        "download"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "48c4f8673eca38696f47ee1e384d52ac257fa3fa2913a08e3a70d68ca7f08cc4",
                "md5": "6867bfc983bef5cd8e7cd3b336933f2b",
                "sha256": "a4c03e52f0a7449ef0cdb957c9895852dbb31dbd2d575d9cf11b06d25fcfa7b0"
            },
            "downloads": -1,
            "filename": "pwebarc_dumb_dump_server-1.5.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6867bfc983bef5cd8e7cd3b336933f2b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 5314,
            "upload_time": "2023-12-04T19:58:20",
            "upload_time_iso_8601": "2023-12-04T19:58:20.388672Z",
            "url": "https://files.pythonhosted.org/packages/48/c4/f8673eca38696f47ee1e384d52ac257fa3fa2913a08e3a70d68ca7f08cc4/pwebarc_dumb_dump_server-1.5.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "08e48ab2bfe37f227e6ab2b8d71c40501aa4995e77850c98057a97e8512c45b4",
                "md5": "830718284a3f562eea238611cc17f9dd",
                "sha256": "714844b87482e63a4e95efee89b5ca82ec6810848ab6f6e5cec5081beeb601ef"
            },
            "downloads": -1,
            "filename": "pwebarc-dumb-dump-server-1.5.5.tar.gz",
            "has_sig": false,
            "md5_digest": "830718284a3f562eea238611cc17f9dd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 4778,
            "upload_time": "2023-12-04T19:58:22",
            "upload_time_iso_8601": "2023-12-04T19:58:22.052454Z",
            "url": "https://files.pythonhosted.org/packages/08/e4/8ab2bfe37f227e6ab2b8d71c40501aa4995e77850c98057a97e8512c45b4/pwebarc-dumb-dump-server-1.5.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-04 19:58:22",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pwebarc-dumb-dump-server"
}
        
Elapsed time: 0.21265s