Skip to content

Commit

Permalink
[SERV-908] Reduce cleverness of import-items setup instructions (#55)
Browse files Browse the repository at this point in the history
* Add PATH env var recommendation
  • Loading branch information
Mark A. Matney, Jr authored Sep 8, 2023
1 parent f910374 commit ad91577
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions src/main/scripts/import-items/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,23 @@ Tested with Python 3.6.9.
```bash
#!/bin/bash

python3 -m venv venv_import_items && . $_/bin/activate
# (exit virtual environment later with `deactivate`)
# Create a virtual environment to isolate the system Python installation from the script dependencies that we'll download
python3 -m venv venv_import_items

# Activate the virtual environment; deactivate it later by running `deactivate`
. venv_import_items/bin/activate

# Install the script dependencies to the virtual environment
pip install -r requirements.txt

# Ensure the script is executable
chmod +x import-items.py
```

Also, you may want to add something like this to your shell's initialization file (e.g. `~/.zshrc`), so that you can easily reference the script from anywhere:

```bash
PATH=$PATH:$HOME/path/to/UCLALibrary/hauth/src/main/scripts/import-items
```

## Example usage
Expand Down

0 comments on commit ad91577

Please sign in to comment.