warcat 0.3.0

Command-line tool and library for handling Web ARChive (WARC) files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

# Example on how to write WARC files.
import subprocess
import zlib

import message


def main():
    # Launch the warcat program. The options provided will tell it to read
    # JSON as a line from standard in.
    # In your code, do not use "cargo",
    # use ["warcat", "import", ... ]
    with subprocess.Popen(
        [
            "cargo",
            "run",
            "--features=bin",
            "--",
            "import",
            "--compression=none",
            "--format=jsonl",
        ],
        stdin=subprocess.PIPE,
    ) as process:
        # Write a record header with the given header fields.
        # Note: this header is not valid; it is simply a concise demonstration.
        header = message.Header(
            "WARC/1.1",
            [
                ("WARC-Record-Type", "resource"),
                ("Content-Length", "12"),
            ],
        )
        message.encode(process.stdin, header)

        # Write the record block data.
        checksum = 0

        data = b"Hello world!"
        checksum = zlib.crc32(data, checksum)

        block_chunk = message.BlockChunk(data)
        message.encode(process.stdin, block_chunk)

        # Write the end of the block message.
        block_end = message.BlockEnd(checksum)
        message.encode(process.stdin, block_end)

        # Finish writing the file.
        message.encode(process.stdin, message.EndOfFile())


if __name__ == "__main__":
    main()