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

Add virtualenv to install steps for macOS #4865

Merged
merged 4 commits into from
Mar 8, 2018
Merged

Conversation

robertknight
Copy link
Member

This addresses some issues with h's installation docs noticed while getting @dawariley set up with an h development environment:

  • Add setup steps for virtualenv under Mac
  • Correct the name of the OS (OS X => macOS)
  • Remove a reference to a long-outdated version of Ubuntu
  • Specify more precisely which versions of Elasticsearch are supported

The main issue we ran into is that brew install python now installs Python 3 as python rather than Python 2. The same issue already applies to some Linux distros. For that, I suggest we get #4838 and #4842 merged so that a local dev install works under Python 3.

@codecov
Copy link

codecov bot commented Mar 6, 2018

Codecov Report

Merging #4865 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #4865   +/-   ##
=======================================
  Coverage   96.61%   96.61%           
=======================================
  Files         387      387           
  Lines       21404    21404           
  Branches     1214     1214           
=======================================
  Hits        20680    20680           
  Misses        610      610           
  Partials      114      114

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ae95ecc...4714fe0. Read the comment docs.

This step was previously only listed under the Ubuntu instructions,
but is also needed on macOS. Assuming that Python + pip has been
installed with Homebrew, following the suggested steps, sudo is not
required.
Use Apple's current name for their OS.
Remove a reference to a long-outdated version of Ubuntu from the install
docs.
h currently requires an old version of Elasticsearch.
@lyzadanger
Copy link
Contributor

These seem like straightforward, helpful changes. LGTM. 👍

@robertknight
Copy link
Member Author

I'll take that as an approval.

@robertknight robertknight merged commit 193bfa4 into master Mar 8, 2018
@robertknight robertknight deleted the update-venv-docs branch March 8, 2018 14:43
@dawachan
Copy link

dawachan commented Mar 9, 2018

adding the 'pip install -U pip virtualenv' corrects the first problem i encountered when installing the env, is it worth adding the instructions for removing python 3 which caused the first build of h to fail or at least checking which python?

@robertknight
Copy link
Member Author

Hi @dawariley - h should be fully usable with Python 3 for local development once #4842 is merged, so this should cease to be a problem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants