Skip to content

Commit

Permalink
update INSTALL.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mokko committed Jun 9, 2024
1 parent 94d5346 commit 4dfce95
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 21 deletions.
44 changes: 23 additions & 21 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
```
1 change: 1 addition & 0 deletions New_toml_configuration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# unified configuration
file format for mink and getAttachments using toml format

filename: jobs.toml

```
Expand Down

0 comments on commit 4dfce95

Please sign in to comment.