From 4dfce951a0ebc8f3b5359e9b9e27f1c8dc384e98 Mon Sep 17 00:00:00 2001 From: Maurice Mengel Date: Sun, 9 Jun 2024 18:43:42 +0200 Subject: [PATCH] update INSTALL.md --- INSTALL.md | 44 ++++++++++++++++++++------------------- New_toml_configuration.md | 1 + 2 files changed, 24 insertions(+), 21 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 0cc9022..880bae9 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,25 +1,23 @@ # INSTALLING MpApi ## directly from github -> pip install git+https://github.com/mokko/MpApi#egg=MpApi +``` +pip install git+https://github.com/mokko/MpApi#egg=MpApi +``` -## new clone +## Or new clone +``` git clone https://github.com/mokko/MpApi.git -> cd MpApi -> pip install +cd MpApi +pip install +``` ## from existing git clone Or try this for editable install -> cd MpApu -> git pull -> pip install -e . - -## Prerequisites -* Python >=3.9, https://www.python.org/downloads/ -* pip, a package installer that normales comes as part of Python -* lxml -* requests -* typing_extensions -* some others? +``` +cd MpApi +git pull +pip install -e . +``` ## Configuration I put my configuration and all the data in a directory sdata and @@ -29,15 +27,19 @@ MpApi expects two configuration files - credentials: $home/RIA.toml - jobs.toml: a description of the jobs you planning to run -Credentials.toml has three lines: -> user = "EM_XY" -> pw = "pass" -> baseURL = "https://museumplus-produktiv.spk-berlin.de:8181/MpWeb-mpBerlinStaatlicheMuseen" # this instance is behind a firewall +RIA.toml has three lines: +``` +user = "EM_XY" +pw = "pass" +baseURL = "https://museumplus-produktiv.spk-berlin.de:8181/MpWeb-mpBerlinStaatlicheMuseen" # this instance is behind a firewall +``` jobs.toml is described in separate file. ## Mink.py as frontend -Use mink.py as commandline frontend for MpApi. +Use mink as commandline frontend for MpApi. Try mink to see if everything is installed correctly: -> mink -h +``` +mink -h +``` \ No newline at end of file diff --git a/New_toml_configuration.md b/New_toml_configuration.md index a66988e..942ba17 100644 --- a/New_toml_configuration.md +++ b/New_toml_configuration.md @@ -1,5 +1,6 @@ # unified configuration file format for mink and getAttachments using toml format + filename: jobs.toml ```