Getting Started

Installation

To install the hidos package from the command line:

python -m pip install git+https://gitlab.com/perm.pub/hidos.git

Alternatively, you can use only git instead of hidos, but using git directly is not as easy or convenient as using hidos.

Signed vs unsigned digital successions

For evaluation and testing purposes, it is easier to create unsigned digital successions. To do this, use the --unsigned option immediately after hidos on the command line:

hidos --unsigned ...

For long-term public usage, it is necessary for digital successions to be signed. Otherwise anybody can amend your digital succession once public.

A GPG/PGP key is used to sign a digital succession. Hidos uses git for signing. Setting up git to sign commits will enable signed digital successions. There are many instructions on the web for creating keys and getting setup to sign with git. Three such guides for doing so can be found at:

Git Setup

You will need to install git if not already installed. If not already setup, you want to set your name and email for git commits. Two online guides to doing this can be found at:

Git repositories

You will want a local git repository to store your digital succession until you are ready to make it public.

The easiest way to create a local git repository is as such:

mkdir my_repo_dir
cd my_repo_dir
git init

If your current directory is in a git repository, then hidos will use it by default. Optionally you can use the --git-dir option to point to the git repository you want hidos to use:

hidos --git-dir path_to_repo_dir ...

Git branches

Hidos does not alter the working directory of a git repository. Unless you are doing an advanced operation, you do not want to checkout the branch of a digital succession. For normal usage, the digital succession is stored in a branch in a git repository but is never checked-out into the working directory.

To create and amend digital successions, see the Writing Digital Successions.