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.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| pypreservica-4.2.2.tar.gz | 137.5 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pypreservica-4.2.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 261.7 kB
Release files / pypreservica-4.2.2.tar.gz
| Download URL | pypreservica-4.2.2.tar.gz |
|---|---|
| Size | 137.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
816685dd7cee7458643469104c74f0626f232a081aed72114fdcc5bfc96acbc8
|
|
BLAKE2b-256 checksum How to use checksums |
fbb6a82e6113e5b909cfc9b9507759bd51f812329a687f7e2db0117a62215765
|
| 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.2.2-py3-none-any.whl
| Download URL | pypreservica-4.2.2-py3-none-any.whl |
|---|---|
| Size | 124.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
37555ff8a9a6f1fd75ab6b222d87072ff6678409ff05c1fb7d04f3faa14c5a41
|
|
BLAKE2b-256 checksum How to use checksums |
59ecdff87f8ef8825cb2b7331374bbd26ba0a9fdedf970c0925bf991b6823578
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.0
|
Security for pyPreservica 4.2.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
