ocfl-py documentation

ocfl-py is a Python reference implementation of the Oxford Common File Layout (OCFL). It provides a number of command-line tools to validate and manipulate OCFL Objects and OCFL Storage Roots, a Python library that may be used in other code, and additional test fixtures.

• Installing ocfl-py
  • Install with pip
  • Get the source code
• Command Line Tools
  • ocfl-root.py - OCFL Storage Root manipulation script
  • ocfl-object.py - OCFL Object manipulation script
  • ocfl-validate.py - OCFL Validation script
  • ocfl-sidecar.py - OCFL Sidecar creation script
  • Demonstration Examples
  • Inventory validation with JSON Schema
• API Reference
  • ocfl.Object
  • ocfl.StorageRoot
  • ocfl.Inventory
  • ocfl.Version
  • ocfl.InventoryValidator
  • ocfl.VersionMetadata
  • ocfl.NewVersion
  • ocfl.Constants
• Conformance
  • Implementation status for errors and warnings
• Test Fixtures

The code and documentation for ocfl-py are maintained in the <https://github.com/zimeon/ocfl-py> github repository, see guidelines for contributing.