Metadata-Version: 2.1
Name: cdxjGenerator
Version: 0.0.1
Summary: Generate CDXJ TimeMaps for testing elsewhere
Home-page: https://github.com/machawk1/cdxjGenerator
Author: Mat Kelly
Author-email: me@matkelly.com
License: MIT
Download-URL: https://github.com/cdxjGenerator
Description: # CDXJ Generator
        
        A Python script to generate CDXJ TimeMaps for testing elsewhere. 
        
        # Install
        
        This tool is published to pypi. To install it:
        
        `pip install cdxjGenerator`
        
        To use the development version, clone this repository then `pip install .`
        
        
        ## Usage
        
        These inststructions assume installation via `pip`.
        
        To run:
        
            cdxjGenerator [number of lines] [URI-R]
            
        For example:
        
            cdxjGenerator 12
            
        ...will generate CDXJ output (to stdout by default) consisting of entries for 12 random URIs. Alternatively:
        
            cdxjGenerator 25000 memento.us
            
        ...will generate 25,000 entries for the URI-R `memento.us`. This output can be written to a file like:
        
            cdxjGenerator 25000 memento.us > sample.cdxj
        
        The resulting file will likely need to be sorted before used elsewhere. Do this via:
        
            LC_ALL=C sort sample.cdxj > sample_sorted.cdxj
        
        This can also be performed in a single command, instead of writing to the temporary, unsorted `sample.cdxj` like:
        
            cdxjGenerator 25000 memento.us | LC_ALL=C sort > sample_sorted.cdxj
        
        ## Background
        TimeMaps are lists that enumerate URIs of resources that encapsulate prior states of the given resource. ([RFC7089 - Memento](https://tools.ietf.org/html/rfc7089)). TimeMaps are often expressed in an extension of the Web Linking ([RFC5988](https://tools.ietf.org/html/rfc5988)) format. Additional, less common formats, like JSON and CDXJ TimeMaps can also express the same information in a less rigid format. [CDXJ](https://github.com/oduwsdl/ORS/wiki/CDXJ) is the most flexible of the three and is used by [InterPlanetary Wayback (ipwb)](https://github.com/oduwsdl/ipwb), which sparked the initial need for this software existing.
        
Keywords: web archives replay cdxj memento
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: System :: Archiving
Classifier: Topic :: System :: Archiving :: Backup
Classifier: Topic :: System :: Archiving :: Mirroring
Classifier: Topic :: Utilities
Provides: cdxjGenerator
Description-Content-Type: text/markdown
