seano 1.0.0

A Git-backed notes database, optimized for software release notes

Seano

Seano (a sea of notes) is a primitive, lightweight database that automatically associates records with the Git tags where the records where first created.

Records in a Seano database are Json objects, which are stored on disk as distinct YAML files to improve human-readability. The primary key of the records is an arbitrary string, which is encoded into the filename of the YAML file, and is colloquially referred to as the "note ID". Note IDs are random hex strings by default, but under the hood, they can be pretty much any filesystem-safe string.

Seano is heavily inspired by reno, written by Doug Hellmann at OpenStack, and bears a number of similarities to it. The main difference is that Seano is designed more for general-purpose (though, still lightweight) storage, and concomitantly, is engineered to more easily coexist with third party data formatters.

Copyright 2024 Andrew Keller

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.