ocfl-py - A Python implementation of OCFL
Project description
ocfl-py is a Python reference implementation of the Oxford Common File Layout (OCFL). It also provides a number of command-line tools that may be useful for validating and manipulating OCFL Objects and OCFL Storage Roots. The code implements the current OCFL specification v1.1 while retaining support for v1.0. See implementation status for errors and warnings for details of validator support.
See ocfl-py documentation on ReadTheDocs.
Installing
This code requires Python 3.
This supports the OCFL specifications v1.1 and v1.0. To get the most up to date version check out the main branch from github.
I hope to keep a fairly current version on PyPI, which can be installed or upgraded with:
pip install –upgrade ocfl-py
The latest version is in the main branch on github.
Use
There should then be four command-line scripts available:
ocfl-root.py - add or access OCFL objects under an OCFL storage root
ocfl-validate.py - validate OCFL objects, OCFL storage roots or standalone OCFL inventory files
ocfl-object.py - build, manipulate, extract from or validate a stand-alonde OCFL object
ocfl-sidecar.py - update OCFL inventory sidecar file (useful for manually building examples and test cases)
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.
Contributing
Bug reports welcome as github issues.
See CONTRIBUTING.md for guidelines for contributing.
Other Python OCFL Code
See also OCFL-Core which is another Python implementation of OCFL, designed to support the InvenioRDM repository, and other OCFL implementations.
Copyright and License
Copyright 2018–2025 Simeon Warner and contributors. Provided under the MIT license, see LICENSE.txt.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ocfl_py-2.0.1.tar.gz
.
File metadata
- Download URL: ocfl_py-2.0.1.tar.gz
- Upload date:
- Size: 98.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
6020c8c9bf7e1124d5c4df8170daa6b4ab456a5a9f8448c5ccf6064368764087
|
|
MD5 |
66581f6944a49b50bd335dbec38e37c3
|
|
BLAKE2b-256 |
92330630fb0b06c9e8913831492f70e7a3b8f6bceb83ed12072c713d12ccdec6
|
File details
Details for the file ocfl_py-2.0.1-py3-none-any.whl
.
File metadata
- Download URL: ocfl_py-2.0.1-py3-none-any.whl
- Upload date:
- Size: 92.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
7870e7f76a6b7aff9e602d710e2b7f72c4546e0f371ba183ddb86eda6311d0ad
|
|
MD5 |
973bb421d8760c109a9a2b5cc8f7bb95
|
|
BLAKE2b-256 |
11d489fd342b64171abd74b055dbde4c7370cb16a07b7e03319c7539ed058e96
|