Hidos Documentation

Hidos is a command-line tool and Python library to access and create document successions.

Browse the tutorial to Read a Document Succession for a quick example of Hidos in use.

Technical Details

Technical specifications:

• Document Succession Identifiers (DSI)
• Document Succession Git Layout (DSGL)

Data Sources

As of 2024, Hidos defaults to using a combination of the GitHub Web API, the Software Heritage Archive Web API, and any public Git repository to find and download document successions.

Document Formats

Hidos is designed for document snapshots that can be digitally encoded as either a "frozen" file or directory.

The initial use case for document successions is with the Baseprint document format, based on JATS XML. For an introduction to Baseprint document successions, visit try.perm.pub.