pyPreservica
Python language binding for the Preservica API
This library provides a Python class for working with the Preservica Rest API
https://developers.preservica.com/api-reference
Wiki with example scripts https://github.com/carj/pyPreservica/wiki
Quick Start
Fetch an asset and browse its parent folder:
from pyPreservica import *
client = EntityAPI()
# Fetch an asset by its UUID
asset = client.asset("dc949259-2c1d-4658-8eee-c17b27a8823d")
print(asset.title) # LC-USZ62-20901
print(asset.security_tag) # open
# List all children of a folder
folder = client.folder(asset.parent)
for child in client.children(folder.reference):
print(child.title, child.entity_type)
Upload a file as a new asset into an existing folder:
from pyPreservica import *
upload = UploadAPI()
folder_ref = "ae108c8f-b058-4228-b099-6049175d2f0c"
package = simple_asset_package(preservation_file="picture.tiff", parent_folder=folder_ref)
upload.upload_zip_package(package)
Search the repository:
from pyPreservica import *
content = ContentAPI()
for hit in content.simple_search_list("London"):
print(hit)
Credentials can also be passed as constructor arguments or stored in a credentials.properties file.
See the full documentation for all authentication options.
Documentation
The full documentation is available at: https://pypreservica.readthedocs.io/
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/carj/pyPreservica
For announcements about new versions and discussion of pyPreservica please subscribe to the google groups forum https://groups.google.com/g/pypreservica
License
The package is available as open source under the terms of the Apache License 2.0
Installation
pyPreservica is available from the Python Package Index (PyPI)
https://pypi.org/project/pyPreservica/
To install pyPreservica, simply run this simple command in your terminal of choice:
$ pip install pyPreservica
1 maintainer
Metadata
1 maintainer
Release files for pyPreservica 4.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pypreservica-4.1.0.tar.gz | 117.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pypreservica-4.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 225.6 kB
Release files / pypreservica-4.1.0.tar.gz
| Download URL | pypreservica-4.1.0.tar.gz |
|---|---|
| Size | 117.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
853ab9b050c190ef9f6f8e22d2f0d19387fb14aaf4068ca702fab3afbeb54552
|
|
BLAKE2b-256 checksum How to use checksums |
31946b29fa0139f95f8dc811d5f64495b423f67db36bb4b4e6769d832c2ca422
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.0
|
Release files / pypreservica-4.1.0-py3-none-any.whl
| Download URL | pypreservica-4.1.0-py3-none-any.whl |
|---|---|
| Size | 108.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
36f291b58214761d3e2a517969a471883e35790ed21f2d8d6054ce871cb55e3c
|
|
BLAKE2b-256 checksum How to use checksums |
485d26b31b1b2e44bab4ad78d91b25a86f32b32d23ac298d1fb7e07e87703ac8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.0
|
