- Notifications
You must be signed in to change notification settings - Fork0
License
Munchmuseet/munch-api
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
This project is creating an API for accessing data regarding texts written by Edvard Munch.
The API is provided as a service for the following project:munch_search
To get started, please get a copy of this repository on your local drive and make sure the necessary software is installed.
The command will build themunch_api
docker image needed for themunch_search Application.
To run the application as a separate service (for testing purposes).
Two APIs are provided with the application:http://localhost:5000/N
provides a list of all the files/parents found by the application.
The response is a JSON object with one key:data
.data
is a array with filenames/parents e.g.
{"data": ["MM_N3701.xml","No-MM_N3700.xml"]}
The following API is provided in order to retrieve the parsed data from the parent:http://localhost:5000/N/<parentfilename.xml>
The installation of Docker is necessary for this project. Docker is available here:https://www.docker.com/get-started
Python version 3.6 or above is needed and available here:
https://www.python.org/downloads/
The Python Package Index (PyPI) is included by default in python version 3.4 and above.
Execute the following command in the command line to install the additional Python libraries needed for the project:pip install -r requirements.txt
The project will parse and analyse data located in./_data/N
The data is not a part of the repository and has to be aquired separately.
In order to move all the relevant data from subfolders of./_data/N
execute:python app/prepareData.py
In order to get an overview of the data, or for testing the application, runpython app/analyseData.py
A progress bar will indicate the progress.
Distributed under the MIT License. SeeLICENSE
for more information.
Amelie Fritsch -https://github.com/amelie-fri
Project Link:https://github.com/your_username/repo_name
About
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
Packages0
Languages
- Python97.1%
- Dockerfile2.9%