Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Windows and Linux Script Installers #78

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Windows and Linux Script Installers #78

wants to merge 10 commits into from

Conversation

caldwella2
Copy link
Collaborator

@caldwella2 caldwella2 commented Apr 6, 2021

Together we decided it would be easier to have a script to download all the spacy downloads and pipenv installs in one go rather than having to individually type and run them one at a time.

What is the current behavior?

The user has to individually type/run each command to download spacy and pipenv.

#72

What is the new behavior if this PR is merged?

Pertaining to the operating system they are using, the user can type install.bat or install.sh to install the spacy downloads as well as pipenv installs.

pipenv install
pipenv run python -m spacy download en_core_web_sm
pipenv run python -m spacy download en_core_web_md

The installs and downloads above are what is inside install.bat for Windows and in install.sh there is an additive of:

pip_version install pipenv -U

Please describe the pull request as one of the following:

  • Bug fix
  • Breaking change
  • New feature
  • Documentation update
  • Other

Other information

This PR has:

  • Commit messages that are correctly formatted
  • Tests for newly introduced code
    (Other Windows and Linux users tested the installs)
  • Docstrings for newly introduced code

Developers

@PaigeCD @caldwella2 @angusn8 @connellyw @nathandloria

@caldwella2 caldwella2 added enhancement New feature or request Team 3 This tag serves as a `claim` for team 3 to work on the issue initially labels Apr 6, 2021
@enpuyou
Copy link
Contributor

enpuyou commented Apr 7, 2021

Hi @caldwella2, thanks for the PR. Can you please update the PR title with a more descriptive summarization of the change? Thanks!

@caldwella2 caldwella2 changed the title Issue#72 Windows and Linux Script Installers Apr 7, 2021
Copy link
Collaborator

@noorbuchi noorbuchi left a comment

Choose a reason for hiding this comment

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

Thanks for your work on this feature. I have a few small requests before merging this.

  1. It's important to include documentation on those scripts by updating README.md and letting users know that they could either follow the individual commands OR run the scripts you wrote. Additionally, you'll need to include the commands to run the scripts and which one for which operating system.
  2. Since there aren't any changes being made to the python files, please make sure to not include Pipfle.lock in this pull request
  3. I think it's a good idea to put these scripts in a separate folder that could be called scripts. This is important to keep the repository organized, especially that new scripts are being added for Docker. We can discuss this further if you have any questions.

@corlettim corlettim requested a review from munzekm April 14, 2021 19:26
@nathandloria nathandloria requested a review from noorbuchi April 14, 2021 20:10
@codecov
Copy link

codecov bot commented Apr 14, 2021

Codecov Report

Merging #78 (db75ed8) into master (244b0ba) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #78   +/-   ##
=======================================
  Coverage   92.09%   92.09%           
=======================================
  Files           6        6           
  Lines         253      253           
=======================================
  Hits          233      233           
  Misses         20       20           

README.md Outdated Show resolved Hide resolved
Comment on lines +1 to +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")
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!

Comment on lines +1 to +5


pipenv install
pipenv run python -m spacy download en_core_web_sm
pipenv run python -m spacy download en_core_web_md
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Team 3 This tag serves as a `claim` for team 3 to work on the issue initially
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants