Skip to main content

Read and write ClearWeb archives for Clear Browser.

Project description

clearweb-archive

clearweb-archive is a Python library and command line tool for creating and reading ClearWeb archives. A ClearWeb archive is a password-protected package for portable static HTML sites that can link between pages and include local resources such as images, stylesheets, and scripts.

ClearWeb archives use the Space64 encrypted local archive container through the space64-local-archive Python package.

Install

pip install clearweb-archive

Write

from clearweb_archive import create_clearweb_archive

create_clearweb_archive(
    "site",
    "site.clearweb",
    password="correct horse battery staple",
    title="My Offline Site",
    root="index.html",
)

Read

from clearweb_archive import read_clearweb_archive

archive = read_clearweb_archive(
    "site.clearweb",
    password="correct horse battery staple",
)
root_bytes = archive.root_file.data

CLI

clearweb pack site site.clearweb --password "correct horse battery staple"
clearweb inspect site.clearweb --password "correct horse battery staple"

Security Notes

The password protects archive contents at rest. Applications that open archives may still need to extract or materialize files temporarily for WebView loading; those temporary files should be treated as sensitive data and cleaned up by the application.

ClearWeb is not an anonymity system, VPN, or network privacy tool. It is a local archive format for storing and transporting web content.

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

clearweb_archive-0.1.0.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

clearweb_archive-0.1.0-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file clearweb_archive-0.1.0.tar.gz.

File metadata

  • Download URL: clearweb_archive-0.1.0.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for clearweb_archive-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fc1037b76e771a10c44332132584c71c8ee3f5ac82089452dff0c3394ce44bbf
MD5 2a7dc09b0fca1118f5ff0b35ac475575
BLAKE2b-256 e638aef399e49ae99f6081ffa1125cc1c9b176623c936b4acc36416a35c793a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for clearweb_archive-0.1.0.tar.gz:

Publisher: publish-python.yml on space64-team/clearweb-archive

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file clearweb_archive-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for clearweb_archive-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c48aadb476333fa6ea434110c5872c7ffd92fb85457bbcd9e591307237651e3b
MD5 3d66f0d84713c95c3caa943ccb4c336b
BLAKE2b-256 5e7ffaee361ab145755934d1abc197ae5db6913546fbfb5575845a5ef3e499ae

See more details on using hashes here.

Provenance

The following attestation bundles were made for clearweb_archive-0.1.0-py3-none-any.whl:

Publisher: publish-python.yml on space64-team/clearweb-archive

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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