Bibliotekar

Bibliotekar is a Python project for managing Code Shelves. It consists of an executable called shelf and several modules that can be used in Python.

Scripts

Bibliotekar provides a single executable script that serves as the entrypoint for all commands, shelf. In the folder of a shelf or bibliotekar itself, you can run it using

pixi run shelf <command>

Fore more information, see

pixi run shelf --help

• shelf check <folder or filename> checks that the minimal tracking metadata in the given file or folder is valid and complete.

• shelf deploy <shelf> <out> deploys the given shelf to the given output folder. See also Deployment.

• shelf patch <filename> starts an interactive session to add or update the tracking metadata of the given file.

• shelf show <filename> shows the tracking metadata in the given file.

• shelf update update the shelves from the Copier template.

Releases

Bibliotekar is deployed to a custom PyPI instance hosted in the Code Shelf GitLab group at https://git.esss.dk/groups/dram/code-shelf/-/packages/308. This index is served at https://git.esss.dk/api/v4/projects/356/packages/pypi/simple and the package can be installed using

python -m pip install \
  --extra-index-url https://git.esss.dk/api/v4/projects/356/packages/pypi/simple \
  bibliotekar

or an equivalent command in other package managers.

The code shelves depend on Bibliotekar, and Pixi automatically installs it from the custom index.

Making a new release

New releases are made by creating a tag of the form \d+\.\d+\.\d+. (Should be a valid CalVer version number.) This will trigger the package build and deployment. Note that tags of this form are protected and can only be created by project maintainers.