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

Update README.md for python3 on new macs using zsh as default #91

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rkoppula
Copy link
Contributor

Context

Jasmina faced issues installing Orbyter. These instructions worked for her, adding them in case upcoming newhires face the same issue.

Changes

  • change 1
  • change 2

Behaves Differently

  • behavior 1
  • behavior 2

Untested

  • anything untested?

Closes #XXX.

@rkoppula rkoppula requested a review from jeffmm May 11, 2022 23:30
Copy link

@jasminajovanovic jasminajovanovic left a comment

Choose a reason for hiding this comment

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

generic username in the PATH variable, e.g.
export PATH=/Users//Library/Python/3.8/bin:$PATH

Copy link

@jasminajovanovic jasminajovanovic left a comment

Choose a reason for hiding this comment

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

generic username in the PATH variable, e.g.
export PATH=/Users//Library/Python/3.8/bin:$PATH

@@ -83,6 +83,14 @@ mlflow_artifact []:
``` bash
$ pip install cookiecutter
```
If you are on the latest macOS with zsh as the default, you will need to install this using pip3. To do this, update your path variable first by adding the following to your ~/.zshrc.
```
export PATH=/Users/jjovanovic/Library/Python/3.8/bin:$PATH
Copy link
Contributor

Choose a reason for hiding this comment

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

change jjovanovic to the generic $USER

Copy link
Contributor

Choose a reason for hiding this comment

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

or better yet, change /Users/jjovanovic to $HOME

@@ -83,6 +83,14 @@ mlflow_artifact []:
``` bash
$ pip install cookiecutter
```
If you are on the latest macOS with zsh as the default, you will need to install this using pip3. To do this, update your path variable first by adding the following to your ~/.zshrc.
Copy link
Contributor

Choose a reason for hiding this comment

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

Given that the pip wrapper is being deprecated in some Python versions, we should probably make the install instructions more generic. According to the docs, cookiecutter should be installed with

python3 -m pip install --user cookiecutter

And it then says to add ~/.local/bin to the PATH variable, which is where Python binaries are now being installed by default. This should avoid the problem that this fix addresses. Unfortunately I can't test this myself, since my environment likely differs from a new machine setup.

It's also probably not a good idea to assume where Python binaries will be installed on new machines in the future, particularly since the path recommended here is assuming a specific Python version (which is currently 2 minor releases behind the latest stable version).

Now that I'm thinking about it, we should probably just refer the user to the install instructions in the cookiecutter docs and avoid any responsibility here. 😛

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.

3 participants