diff --git a/README.md b/README.md index 7e5df1b..97afa3f 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,35 @@ # Uploader to automate the Upload and Import of Objects in museum-digital via WebDAV The purpose of this app will be to allow museums to more simply automate the upload of -their collection data to museum-digital. It is thus targetted at museums using museum-digital +their collection data to museum-digital. It is thus targeted at museums using museum-digital as a publication platform, while using another collection management system. While collection management systems differ, an automatic import to museum-digital works in -a uniform way. Import data is uploaded via WebDAV, an import is configured using a text file. ([See here](https://de.handbook.museum-digital.info/import/importe-selbst-durchfuehren.html)) +a uniform way. Import data is uploaded via WebDAV, an import is configured using a text file. +([See here](https://de.handbook.museum-digital.info/import/importe-selbst-durchfuehren.html)) This part of the automatic importing can thus be solved in a one-fits-all solution here. Collection management system-specific export scripts are necessary to present the present app with data to upload. The export itself is thus out of the scope of the tool described here. +## Idea / Very Short Summary / Use Cases + +### Automatic Publication from Separate Collection Management System + +A museum wants to use museum-digital only for publication, while they use a separate collection +management system. They want to keep their published collections up to date with their local data. +Hence, they automate an export from their local program. To upload, they move the data into a +specified folder. The present application monitors the folder and uploads the data to museum-digital. + +### Automating Image Uploads + +If a museum produces a lot of digital media files (e.g. lots of scans of books / manuscripts), +it may become tedious to upload them manually. This becomes an issue all the more if there are +lots of uncompressed, high resolution files (again, common with scans). +In this case, it may be useful to use this application to automatically upload the object images +for import using the `ImageByImport` parser - a.k.a. the matching of image files to objects based +on their file name according to pre-defined rules. + ## Workflow ### Setup @@ -26,8 +45,7 @@ It will hence attempt to do so when first run (or unless all relevant informatio - Auth token for WebDAV access - Institution ID - Parser -- Location of metadata files to upload -- Location of images files to upload +- Location of uploadable files - Decision, whether objects should be imported as public #### Setup workflow @@ -63,26 +81,19 @@ It will hence attempt to do so when first run (or unless all relevant informatio ## Commands -- [ ] Upload +- [x] Upload - [ ] Verify ability to connect -- [ ] Set optional setting (do the settings need to be validated?) -- [ ] List config +- [x] Set optional setting (do the settings need to be validated?) +- [x] List config - [ ] Remove optional setting (in case an erroneous setting value has been set) - [ ] `--version` command to check currently installed version - [ ] Version check (via Gitea release RSS feed) ## Interface -- A command line interface is sufficient for this application - -## Libraries/resources to include - -- `requests` / HTTP library -- JSON parser -- XML parser (for version/update check) -- WebDAV client: [Python](https://pypi.org/project/webdav4/), [Golang](https://github.com/studio-b12/gowebdav) - -Either JSON or XML may also serve to store the config data. +- A command line interface is sufficient for this application. It would be nice to + eventually provide a GUI for running settings as well as to provide some GUI for + warnings to update the app. ## Additional, optional features