Skip to content

Commit 7f1e752

Browse files
committed
Update README
1 parent 255b7cf commit 7f1e752

File tree

2 files changed

+29
-22
lines changed

2 files changed

+29
-22
lines changed

README.md

+27-12
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,42 @@
33
API Specification: http://docs.zetcom.com/ws
44

55
Libraries
6-
* mpapi.py - low level client; all endpoints; agnostic of metadata format
6+
* mpapi.py - low level client; all endpoints; agnostic of metadata format
7+
* search.py - make a MuseumPlus query
8+
* module.py - encapsulate data from or for MuseumPlus's modules
79
* sar.py - search and response; slightly higher level client; specific to Berlin instance
8-
* chunky.py - search responses in chunks
10+
* chunky.py - request responses in chunks
911

10-
Scripts (installed in path, all for the command line)
12+
Scripts (installed in path, command line)
1113
* mink - write your own jobs and execute them with cli command
12-
* getAttachments - download attachments from multimedia items (using groups)
14+
* getAttachments - download attachments from multimedia items (using groups etc.)
15+
16+
For Debugging
17+
* getAttachment - get single attachments
18+
* getItem - get a single item
19+
* getDefinition - ask MuseumPlus for instace's definitions
20+
* updateItem - work in progress
21+
* validate - validate native xml
1322

1423
Requirements
15-
* Python 3.9
24+
* Python 3.11 (?) - not sure about exact Python version required
1625
* lxml
1726
* requests
1827

1928
For Testing
2029
* pytest
2130

2231
# Version History
23-
- 0.1.8 20230801
24-
- general package cleanup,
25-
- changed several vocabulary endpoints to have more consistent names and parameters
26-
- added Vocabulary class in analogy to Module
27-
- 0.1.7 new credentials
28-
- 0.1.6
29-
- 0.1.5 20220710 adds getAttachments script.
32+
* 0.1.10 20240604
33+
* unified configuration using jobs.toml
34+
* 0.1.8 20230801
35+
* general package cleanup,
36+
* changed several vocabulary endpoints to have more consistent names and parameters
37+
* added Vocabulary class in analogy to Module
38+
* 0.1.7 new credentials
39+
* 0.1.6 20221226
40+
* chunks are now zipped to save disk space
41+
* 20221210
42+
* use separate command getAttachments to d/l attachments
43+
* 0.1.5 20220710 adds getAttachments script.
44+

src/mpapi/mink.py

+2-10
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
mink.py -j job
77
88
CONFIGURATION
9-
$HOME/RIA.toml # put it out of harm's way
10-
jobs.toml # defines/describes multiple jobs; expected in project dir
9+
$HOME/RIA.toml # credentials
10+
jobs.toml # defines multiple jobs; expected above project dir
1111
1212
DIR STRUCTURE
1313
projectData # <-- use it as working directory (pwd)
@@ -19,14 +19,6 @@
1919
getItem : save a single item to disk
2020
getPack : for a single id, get multi-type info (Objects, Multimedia, Persons...)
2121
pack : pack together several (clean) files
22-
23-
NEW
24-
20240604
25-
* unified configuration using jobs.toml
26-
20221226
27-
* chunks are now zipped to save disk space
28-
20221210
29-
* use separate command getAttachments to d/l attachments
3022
"""
3123

3224
import datetime

0 commit comments

Comments
 (0)