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.

Sign up for GitHub

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

docs: recommend installation via pip -e #693

Merged
merged 2 commits into from
Aug 5, 2020
Merged

docs: recommend installation via pip -e #693

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d221646
docs: recommend installation via pip -e
busunkim96 Jul 24, 2020
41e6e39
Merge branch 'master' into busunkim96-patch-4
SurferJeffAtGoogle Aug 5, 2020
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
4 changes: 2 additions & 2 deletions synthtool/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ This tool helps to generate and layout cloud client libraries. Synthtool runs th

3. **Docker** Some synth.py files require [Docker] to generate code.

4. Install this library with pip:
4. Clone this repository and install this library with pip:

```
cd synthtool
export PYTHONPATH=`pwd`
python3 -m pip install -e .
Copy link
Contributor

Choose a reason for hiding this comment

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

Earlier versions of this file had the exact same command, but the command failed for Justin Beckwith.

So line 19 looks good, but line 23 doesn't work for all users.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@JustinBeckwith Do you remember how this failed for you?

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh gosh, this was a while ago now, and I can't remember what was failing. What I do remember is that when installing directly from the repository, synthtool --version became practically useless. I was struggling to get the right version of synthtool on my path, and doing a --version would always tell me the same version regardless of which commit I had installed against.

I'd like to arrive at one of two places here. Either:

  • We update synthtool --version to include the sha at which it's running alongside the current version or
  • We arrive at a place where we're consistently releasing every time after updates are made

```


Expand Down