Skip to content

Post a Temporary Document Succession

In this tutorial, you will learn how to post a temporary unsigned document succession.

Prerequisites

To post an unsigned succession, ensure you have the following prerequisites:

  • A GitHub account
  • Git installed
  • Hidos installed
  • GitPython installed (included with pip install hidos[git])

Steps

1. Create an empty GitHub repository

Do not initialize your new repository with any files. Start with an empty repository (and make sure the Git repository is public).

Create a new repository

Let <reponame> represent the name you give to this new repository.

2. Create document contents

echo Hello World. > doc.txt

3. Create a local bare Git repository

git init --bare <reponame>
cd <reponame>

4. Create an unsigned document succession

hidos git create main

A new Document Succession Identifier (DSI) will be printed. Make a note of this DSI, which allows other websites and software to identify this document succession.

5. Commit document contents to the document succession

hidos git commit ../doc.txt main 1

6. Push the document succession to GitHub

git push -u <url-to-github-repo> main

Replace <url-to-github-repo> with either https://github.com/<username>/<reponame>.git or git@github.com:<username>/<reponame>.git.

Conclusion

You have successfully created an unsigned document succession and amended a document snapshot to it as edition 1.

Software and websites can now retrieve this document succession using the DSI. Running the following command from any computer:

hidos get dsi:<your_new_temp_dsi>

will output

Hello World.

For long-term public dissemination, you need to write signed document successions and use a document format designed for long-term preservation. See the try.perm.pub guide on How to Publish a Signed Succession to learn more.