gutenberg

node-gutenberg

APIs for interacting with Project Gutenberg

Setup

1. rsync the Gutenberg catalogue to a local directory using the Mirror instructions provided by http://www.gutenberg.org/. Warning: this catalogue includes all file exports and is ~650gb Note: the implementation expects the hierarchy of small directories, rather than the big root, explained in the Mirror instructions

2. Download the gutenberg catalogue metadata via Zipped RDF(Current Format) as provided by http://www.gutenberg.org.

3. Instantiate the gutenberg module instance with options:

  var gutenberg = require('gutenberg');

  var instance = new gutenberg({
      catalogDir : "../path/to/rsync/gutenberg/dir",
      rdfFile: "../path/to/gutenberg/gutenberg.rdf.zip"
  );
  instance.catalogueGetRecords({},
                function(err, records) {
                    if (err)
                      // handle error
                      
                     // process records
                });

Optional Recommendations

Cron data dependencies

1. Create file gutenberg-sync.sh with the following contents:

    rsync -av --progress --del [e-mail]::gutenberg [catalog path]/catalog < /dev/null &
    
    wget http://gutenberg.readingroo.ms/cache/generated/feeds/catalog.rdf.zip [catalog path]/catalog.rdf.zip

• Replace [catalog path] with your desired path

1. Grant the script execution rights `chmod +x gutenberg-sync.sh'
2. Run crontab -e and append a weekly screen execution 5 8 * * 6 [user] [script path]/gutenberg-sync.sh

• Replace [user] with the system user that will be executing the job
• Replace [script path] with the location of your shell script

This will sync both the gutenberg catalogue and the metadata for querying.

API

Constructor

Because the gutenberg catalogue is massive and there exists a bandwidth cap (per IP) for downloads, this component does not attempt to fetch catalog content directly. Instead, it is recommended that you run a recurring job (CRON) that will incrementally rsync the catalogue to your runtime environment.

Required

• catalogDir - the directory location for a synced gutenberg catalogue
• rdfFile - the zipped RDF metadata file which describes the gutenberg catalogue

CatalogueGetRecords

Parse the rdfFile and process array of json records for each etext.

Required

• options - configuration object; currently empty or null
• callback - function with arguments (error, results), where results is the record collection

Contact & Issues

Issues: https://github.com/DeepElement/node-gutenberg/issues

CI: https://travis-ci.org/DeepElement/node-gutenberg

License

(The MIT License)

Copyright (c) 2008-2014 Todd Morrison [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.