BASC-WARC

Bibliotheca Anonoma’s library for creating and managing WARC files.

Warning

This is not even in alpha right now. This is in the planning / pre-alpha stage. If you use this, ANYTHING can change without any notice whatsoever, everything can be overhauled, and development may even stop entirely without any warning.

This library is primarily being written for BASC-Archiver, and planned to be integrated into a new/existing downloading library.

Planned Features

• Python 2/3 compatibility.
• Thread-safe.
• Streaming reading/writing of WARC files, for dealing with very large files on systems with smaller amounts of memory.
• CDX file creation and management.
• Included scripts that do useful work, possibly allowing viewing or extracting information and files from WARCs / appending WARCs / creating CDX files from WARCs, similar to megawarc, CDX-Writer, or warctools.

License

Written in 2015 by Daniel Oaks <daniel@danieloaks.net>

To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.

You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see http://creativecommons.org/publicdomain/zero/1.0/.

Library

• 1. basc_warc.WarcFile — Managing WARC files
  • 1.1. Creating a new record
  • 1.2. Adding specific records
  • 1.3. Adding custom records
  • 1.4. Writing files out
• 2. basc_warc.Record — WARC Records
  • 2.1. Creation
• 3. basc_warc.RecordHeader - WARC Record Header
  • 3.1. Fields
  • 3.2. Simple field access
• 4. WARC Record blocks
  • 4.1. Bytes
  • 4.2. warcinfo Block

Index