From 85e6a9959cd1b2d8361c34ae1dd03a7d8995cf51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gabriele=20H=C3=B6fler?= Date: Tue, 19 Nov 2019 14:39:17 +0100 Subject: [PATCH] Add requirements, add docu in README --- README.md | 15 +++++++++++++-- requirements.txt | 4 ++++ 2 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 requirements.txt diff --git a/README.md b/README.md index 4fbfa39..3c4dc10 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,21 @@ [Jupyter Notebook](Extract_Bibliographic_Info_From_Alma.ipynb) for extracting bibliographic information for a given list of unique identifiers. -If you want to try this on your local machine, please take note that you will need to get -the [catalogue](https://labs.onb.ac.at/gitlab/labs-team/catalogue) module by executing +## Setup + +If you want to try this on your local machine, please take note that you will need to +do the following: + +### Get Submodule +Get the [catalogue](https://labs.onb.ac.at/gitlab/labs-team/catalogue) module by executing ``` cd catalogue git submodule init git submodule update ``` + +### Install requirements +After setting up your venv, install the requirements for the project: +``` +pip install -r requirements.txt +``` diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..ac4b374 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +jupyter >= 1.0.0 +openpyxl >= 3.0.1 +pandas >= 0.25.3 +xlrd >= 1.0.0 -- GitLab