Skip to main content

ocfl-py - A Python implementation of OCFL

Project description

https://travis-ci.org/zimeon/ocfl-py.svg?branch=main https://coveralls.io/repos/github/zimeon/ocfl-py/badge.svg?branch=main

WORK IN PROGRESS - NO GUARANTEE, NO MONEY BACK :-)

Attempts to follow OCFL specification v1.0, see implementation status for errors and warnings for details of validator support.

Installing

This code requires Python 3.

This code attempts to support the OCFL specification v1.0 and to additional developments. To get the most up to date version check out the main branch from github (or if you are reckless you can try the develop branch).

I hope to keep a version not too far out of date on PyPI too, which can be installed or upgraded to the current version with:

pip install –upgrade ocfl-py

Use

There should then be three scripts available:

  • ocfl-validate.py - validate OCFL objects or OCFL storage roots
  • ocfl-object.py - build, manipulate, extract from or validate an OCFL object
  • ocfl-store.py - add or access OCFL objects under an OCFL storage root

Each script takes -h for help.

See examples in docs folder for use of these scripts.

The code is also available as a module ocfl for other python code to use. However, the interfaces should not be considered stable at the moment.

Contributing

Bug reports welcome as github issues.

See CONTRIBUTING.md for guidelines for contributing.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ocfl-py, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size ocfl_py-1.1.0-py3-none-any.whl (49.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size ocfl-py-1.1.0.tar.gz (39.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page