This is a major set of ease-of-use improvements defining a new server side API. The most important elements are:
- The whole release is organized as a python module; rather than clone the repo for each bookworm, you now install it system-wide.
- All build and update tools are bundled inside a command line executable installed with the package and accessible as
bookworm. After installing, type
bookworm --helpfor an outline of the functions.
- The API code, previously a separate repo, has been folded into this framework, accessible through the command line as
- An easy-to-set-up webserver is available through
bookworm servefor testing and local data exploration.
- Setup help is included under
bookworm config mysql.
- A new command
bookworm add_metadatamakes it easier to extend the metadata around a library.
- The beginnings of test suite are included, including most importantly a standardization of the Federalist papers test set to make sure that Bookworm is configured properly.
It also incorporates various bugfixes. A slightly more extended discussion is available here
I'm naming it "Whitman" because, much like Leaves of Grass, this version is folding a lot of previous stuff from various sources into one updated omnibus volume.
I'm going to let this sit for a little while for comment, but hopefully we can move this straight into a 1.0 alpha release. I would consider doing this now, except that at 1.0, the vocabulary needs to be set in stone to abide by semantic versioning.
- A more consistent API with command line help. Type
bookworm --helpafter installing for some examples.
- All submodules now use the
loggingmodule to write errors. This means that problems can be more easily debugged by running with
bookworm --log-level=DEBUG ...without extraneously dumping all that stuff out.