This is a repository to hold open data schemas for public library data. A data schema describes how data is structured, such as the fields that should be held. It also describes constraints about the data, such as whether a field is optional, and what data type the fields should hold.
The schemas are written using Table Schema. Table Schema is a standard format for describing table data, such as that which can be held in a spreadsheet. A benefit of writing schemas in this format is there are software tools that will provide additional functionality, such as validating that data conforms to a schema.
Descriptive documentation for these schemas is held in the docs directory within this repository.
| Name | File | Description |
|---|---|---|
| Library services | library-services.json | Core details, systems, digital platforms, and operating models for UK library services |
| Libraries | libraries.json | A listing of library locations, coordinates, facilities, and opening hours |
| Membership | membership.json | The membership of a library service |
| Events | events.json | The number of people attending library events |
| Loans | loans.json | The number of items being issued in libraries |
| Mobile library stops | mobile-library-stops.json | Mobile library stops with their timetabled visits |
| Physical visits | physical_visits.json | The number of visits made to library buildings |
| Stock summary | stock_summary.json | Summary of the stock held in libraries |
For each schema, test data is held in the tests folder. This is to enable easy testing of the schema using tools such as CSVLint and Good Tables. These files could also be used for automated testing, when making any schema updates.
For each schema, test files will be provided:
- Each will have one example row of data
- Files with the name _success will provide a successful test
- Files with the the name _fail should fail validation.
We will also be providing real data examples, held in the data folder.
We use SemVer for versioning.
Each schema will share a single version number, which will be updated on making any changes. If a new schema is added it will increment the version number of the current set, rather than start at 0.
All completed schemas will be held in versioned directories in the archive folder in this repository (e.g. archive/0.4.0/). Schemas in development are held in the root folder.
See the list of contributors who participated in this project.