Skip to content
Open
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,27 @@ git clone git@github.com:Allegheny-Ethical-CS/GatorMiner.git
cd GatorMiner
```

This program uses [Pipenv](https://github.com/pypa/pipenv) for dependency management.
This program uses [Pipenv](https://github.com/pypa/pipenv) for dependency management. You can install these dependencies through running the provided scripts or by manually entering the commands.

### Using Scripts

Please read the Manual Commands section below for more information on the commands the scripts contain.

To install using scripts, enter the following command that corresponds to your operating system into your terminal:

#### Mac/Linux:

```
./scripts/install.sh
```

#### Windows:

```
.\scripts\install.bat
```

### Manual Commands

- If needed, install and upgrade the `pipenv` with `pip`:

Expand Down
5 changes: 5 additions & 0 deletions scripts/install.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@


pipenv install
pipenv run python -m spacy download en_core_web_sm
pipenv run python -m spacy download en_core_web_md
Comment on lines +1 to +5
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any status update on the windows script?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are currently working on a version that executes the correct commands with the correct versions, yet we are having some issues where there are some dependencies that error out before installing.

17 changes: 17 additions & 0 deletions scripts/install.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
#!/bin/bash
if [ -f "$(eval 'which pip')" ]
then
pip_version="pip"
elif [ -f "$(eval 'which pip3')" ]
then
pip_version="pip3"
else
$(eval "python3 -m pip install --upgrade pip")
pip_version="pip"
fi

echo $(eval "$pip_version install pipenv -U")
echo $(eval "cd ..")
echo $(eval "pipenv install")
echo $(eval "pipenv run python -m spacy download en_core_web_sm")
echo $(eval "pipenv run python -m spacy download en_core_web_md")
Comment on lines +1 to +17
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great!