Package: wacz
py-waczThepy-waczrepository contains a Python module and command line utility
for working with web archive data using theWACZformat specification. Web
Archive Collection Zipped (WACZ) allows web archives to be shared and
distributed by providing a predictable way of packaging up web archive data and
metadata as a ZIP file. Thewaczcommand line utility supports converting
anyWARCfiles into WACZ files, and optionally generating full-text search
indices of pages.InstallUse pip to install the module and a command line utility:pip install waczOnce installed you can use thewaczcommand line utility tocreateandvalidateWACZ files.CreateTo create a WACZ package you can pointwaczat a WARC file and tell it
where to write the WACZ with the-ooption:wacz create -o myfile.wacz <path/to/WARC>The resultingmyfile.waczshould be loadable viaReplayWeb.page.waczaccepts the following options for  customizing how the WACZ file is assembled.-f --fileExplicitly declare the file being passed to the create function.wacz create -f tests/fixtures/example-collection.warc-o --outputExplicitly declare the name of the wacz being created.wacz create tests/fixtures/example-collection.warc -o mywacz.wacz-t --textGenerates pages.jsonl page index with a full-text index, must be run in conjunction with --detect-pages. Will have no effect if run alone.wacz create tests/fixtures/example-collection.warc -t--detect-pagesGenerates pages.jsonl page index without a full-text index.wacz create tests/fixtures/example-collection.warc --detect-pages-p --pagesOverrides the pages index generation with the passed jsonl pages.wacz create tests/fixtures/example-collection.warc -p passed_pages.jsonl-t --textYou can add a full text index by including the --text tag.wacz create tests/fixtures/example-collection.warc -p passed_pages.jsonl --text-l --log-directoryAdds log files in specified directory to WACZwacz create tests/fixtures/example-collection.warc -l tests/fixtures/logs--tsOverrides the ts metadata value in the datapackage.json file.wacz create tests/fixtures/example-collection.warc --ts TIMESTAMP--urlOverrides the url metadata value in the datapackage.json file.wacz create tests/fixtures/example-collection.warc --url URL--titleOverrides the titles metadata value in the datapackage.json file.wacz create tests/fixtures/example-collection.warc --title TITLE--descOverrides the desc metadata value in the datapackage.json file.wacz create tests/fixtures/example-collection.warc --desc DESC--hash-typeAllows the user to specify the hash type used (sha256 or md5).wacz create tests/fixtures/example-collection.warc --hash-type md5--signing-urlAn optional URL forWACZ signing serverwhich will be used to add a signature to the new WACZ.This URL should point to an authsign/signapi endpoint.See the section on--verify-authfor more info on signing and verification.--signing-tokenAn optional, secret token passed to signing server to allow access. Seeauthsignfor more details.ValidateYou can also validate an existing WACZ file by running:wacz validate myfile.wacz-f --fileExplicitly declare the file being passed to the validate function.wacz validate -f tests/fixtures/example-collection.warc--verify-authNew option in 0.4.0, this option also verifies the WACZ is signed, usingauthsignThe verification can be done locally, or via remote signing/verification server.To use remote server, add--verifier-urlwhich should be a URL pointing to the authsign/verifyendpoint.To run locally, theauthsignmust be installed, which can be done by runningpip install wacz[signing].SeeWACZ Authentication Specon WACZ authentication.This feature and the specification are still in development (alpha-quality) and are subject to change.TestingIf you are developing wacz you can run the unit tests withpytest:pytest tests