diff --git a/README.md b/README.md index 63726230..8849bd3b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # DataRepository_patrons - [Overview](#overview) +- [Getting Started](#getting-started) + - [Requirements](#requirements) + - [Installation Instructions](#installation-instructions) - [Versioning](#versioning) - [Authors](#authors) - [License](#license) @@ -13,6 +16,58 @@ Query EDS information to set `ismemberof` Grouper attributes specific for Figshare identity and access management. +## Getting Started + +These instructions will have the code running on your local or virtual machine. + + +### Requirements + +You will need the following to have a working copy of this software. See [installation](#installation-instructions) steps: +1. Python (3.7.5) +2. [`pandas`](https://pandas.pydata.org/) ([0.25.3](https://pandas.pydata.org/pandas-docs/version/0.25.3/)) +3. `ldap3` (2.6.1) +4. `requests` (2.22.0) + + +### Installation Instructions + +#### Python and setting up a `conda` environment + +First, install a working version of Python (v3.7.5). We recommend using the +[Anaconda](https://www.anaconda.com/distribution/) package installer. + +After you have Anaconda installed, you will want to create a separate `conda` environment +and activate it: + +``` +$ (sudo) conda create -n figshare_patrons python=3.7.5 +$ conda activate figshare_patrons +``` + +Next, clone this repository into a parent folder: + +``` +(figshare_patrons) $ cd /path/to/parent/folder +(figshare_patrons) $ git clone https://github.com/ualibraries/DataRepository_patrons.git +``` + +With the activated `conda` environment, you can install with the `setup.py` script: + +``` +(figshare_patrons) $ cd /path/to/parent/folder/DataRepository_patrons +(figshare_patrons) $ (sudo) python setup.py develop +``` + +This will automatically installed the required `pandas`, `ldap3`, and `requests` packages. + +You can confirm installation via `conda list` + +``` +(figshare_patrons) $ conda list datarepository-patrons +``` + + ## Versioning We use [SemVer](http://semver.org/) for versioning. For the versions available, see the