From 47c456f813bf716fee4d07dd6b358ec550d229fb Mon Sep 17 00:00:00 2001 From: Simeon Warner Date: Wed, 16 Oct 2024 12:57:14 -0400 Subject: [PATCH] Documentation --- ocfl/object.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/ocfl/object.py b/ocfl/object.py index b0c3e7f..d69c72c 100755 --- a/ocfl/object.py +++ b/ocfl/object.py @@ -1,5 +1,14 @@ # -*- coding: utf-8 -*- -"""Core of OCFL Object library.""" +"""OCFL Object library. + +Provides Object class for handling OCFL Object data and operations, including +building, updating and inspecting. Also provides support for generating and +updating OCFL inventories, though these are represented simply as a dict rather +than as a new Python object type. + +This code uses PyFilesystem (import fs) exclusively for access to files. This +should enable application beyond the operating system filesystem. +""" import copy import hashlib import json