Bundled installer for unix #5

rahulrajaram · 2019-04-06T00:05:46Z

1. Description

This PR adds:

python_installer for Bash and Zsh that installs the latest Python (currently Python 3.7.3) (and virtualenv)
bundled_installer for Bash and Zsh that installs Python and the EBCLI.
a README.md with installation instructions and FAQs

2. Testing

2.1. `python_installer`

2.2. `bundled_installer`

if Bash is not in $PATH, the installer fails
if script invokes the python_installer and the ebcli_installer
if python_installer fails, ebcli_installer's execution does not start; the script exits with a non-0 exit-code.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

The script to realize this expects Git to be installed so that it can downlod pyenv from GitHub, and install the latest available Python or one close to it through pyenv. The user of the script will be asked to add the locations of Python to PATH so that installation can be completed and Python subsequently found for other purposes such as for installing the EBCLI. As an aside, the script also installs virtualenv so that the EBCLI self-contained installer can use it. For this, the "pip" executable located within the just-installed Python's "bin" directory (/path-to/pyenv/versions/<PYTHON_VERSION>/bin/) is used.

jsheld · 2019-04-10T23:33:10Z

README.md


-The EB CLI is a command line interface for Elastic Beanstalk that provides interactive commands that simplify creating, updating and monitoring environments from a local repository.


I think we should use a different description. I know you took this from https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3.html, but as a first-read, it's not really intuitive as to what the eb cli is. This description is more relevant:

Elastic Beanstalk (EB) is a service used to deploy, manage, and scale web applications and services. You can use Elastic Beanstalk from the AWS Management console or from the command line using the Elastic Beanstalk Command Line Interface (EB CLI). You should use the EB CLI as part of your everyday development and testing cycle when you favor using the terminal.

Note that this was actually removed.

jsheld · 2019-04-10T23:33:57Z

README.md

+
+1. create **self-contained installations of the EBCLI** in a manner that prevents dependency collisions with other related projects such as the AWS CLI.
+
+2. install the latest **Python 3.7 installation**


install Python 3.7

IMO, all the other verbiage is unnecessary.

Makes sense since we would like to be opinionated and insist on using Python 3.7.

jsheld · 2019-04-10T23:34:16Z

README.md

+
+2. install the latest **Python 3.7 installation**
+
+3. combine 2. and 1. for users who do not want to be completely hands-off (**recommended**).


list in order: combine 1. and 2.

Following your comment above, I think we can eliminate these 3 steps in favour of:

"This package contains scripts to install Python 3.7 and the EBCLI."

jsheld · 2019-04-12T03:59:39Z

README.md

+
+### 3. Advanced usage:
+
+To install the EBCLI, `bundled_installer` runs `ebcli_installer.py`. If you already have Python installed on your system, as will be described later in `4.1.`


The if statement here doesn't seem to convey a complete thought.

jsheld · 2019-04-12T04:01:40Z

README.md

+
+#### 4.2. For the **seasoned Python developer**, what is the advantage of this mode of installation over regular `pip` inside a `virtualenv`:
+
+Even within a `virtualenv`, a developer might find the need to install multiple packages whose dependencies are in conflict. For instance, at various points in time, the AWSCLI and the EBCLI have been conflict with one another owing to their dependency on `botocore`. [One such instance](https://github.com/aws/aws-cli/issues/3550) was particularly bad. When there are conflicts, users have to bear the onus of managing separate virtualenvs for each of the conflicting packages, or find a combination of the packages devoid of conflicts. Both these workarounds become unmanageable over time and as the number of packages that are in conflict increases.


minor nit: replace owing with due

minor nit: replace bad with egregious.

jsheld · 2019-04-12T04:02:12Z

README.md

+
+#### 4.2. For the **seasoned Python developer**, what is the advantage of this mode of installation over regular `pip` inside a `virtualenv`:
+
+Even within a `virtualenv`, a developer might find the need to install multiple packages whose dependencies are in conflict. For instance, at various points in time, the AWSCLI and the EBCLI have been conflict with one another owing to their dependency on `botocore`. [One such instance](https://github.com/aws/aws-cli/issues/3550) was particularly bad. When there are conflicts, users have to bear the onus of managing separate virtualenvs for each of the conflicting packages, or find a combination of the packages devoid of conflicts. Both these workarounds become unmanageable over time and as the number of packages that are in conflict increases.


minor nit: replace bad with egregious.

jsheld · 2019-04-12T04:02:31Z

README.md

+
+Even within a `virtualenv`, a developer might find the need to install multiple packages whose dependencies are in conflict. For instance, at various points in time, the AWSCLI and the EBCLI have been conflict with one another owing to their dependency on `botocore`. [One such instance](https://github.com/aws/aws-cli/issues/3550) was particularly bad. When there are conflicts, users have to bear the onus of managing separate virtualenvs for each of the conflicting packages, or find a combination of the packages devoid of conflicts. Both these workarounds become unmanageable over time and as the number of packages that are in conflict increases.
+
+#### 4.3. On OS X (or Linux systems with `brew`), Is this better than `brew install awsebcli`?


Is should be is

jsheld · 2019-04-12T04:02:58Z

README.md

+
+**Yes**, for a few reasons:
+
+  - the Beanstalk team does not have control over how `brew` operates. So installation problems and will take time to fix as will general queries to be responded to.


remove and

jsheld · 2019-04-12T04:03:59Z

README.md

+
+The opinion of the Beanstalk team is "**No**".
+
+Besides the problem described in `3.2.`, developers new to Python are often confused by the presence of multiple Pythons, and `pip` executables on their system. A common problem that such developers encounter is where they install `eb` with one `pip` executable (presumably using the `sudo` prefix) only to find that `eb --help` despite repeated installations or any other command does not work because the correct set of directories is not being looked within.


Replace Besides with Aside from or In addition to...

jsheld · 2019-04-12T04:05:33Z

README.md

+
+The opinion of the Beanstalk team is "**No**".
+
+Besides the problem described in `3.2.`, developers new to Python are often confused by the presence of multiple Pythons, and `pip` executables on their system. A common problem that such developers encounter is where they install `eb` with one `pip` executable (presumably using the `sudo` prefix) only to find that `eb --help` despite repeated installations or any other command does not work because the correct set of directories is not being looked within.


I would replace only to find that eb --help despite repeated installations or any other command does not work because the correct set of directories is not being looked within. with

only to find that no eb-related commands work because the correct set of directories is not properly referenced.

jsheld · 2019-04-12T04:06:20Z

README.md

+
+Normally, for such developers, usage of `virtualenv` is the correct path forward, however, this becomes yet another hurdle before executing with `eb`.
+
+Another common problem is where, users install Python and `pip` though means not recommended by AWS Documentation such as arbitrary PPAs on Ubuntu, or similar unmaintained sources that lack scrutiny.


remove comma after where

jsheld · 2019-04-12T04:07:07Z

README.md

+
+#### 4.4. Can I execute the Bash scripts in a Cygwin, git-bash and other Bash-like shells on Windows?
+
+**No**. At this time, we do not directly support execution on Bash-like environments on Windows. Please use PowerShell or CMD Prompt to install. You may add to `$PATH` the location of the `eb` and `Python` executables from your Bash-like terminals.


Period after executables and then remove the rest.

jsheld · 2019-04-12T04:08:17Z

README.md

+**No**. At this time, we do not directly support execution on Bash-like environments on Windows. Please use PowerShell or CMD Prompt to install. You may add to `$PATH` the location of the `eb` and `Python` executables from your Bash-like terminals.
+
+#### 4.5. Can I execute the Bash scripts in a `fish` shell?
+**Yes**, but only if you have Bash on your computer. At this time, we do not provide specific guidance on how to set `$PATH` in fish, however, Fish has [detailed documentation](https://fishshell.com/docs/current/tutorial.html#tut_path) for this purpose.


Remove comma after time. Period before however, then continue with However, Fish... Also, we should be consistent in how we reference fish - caps in one case, lower case in another.

jsheld · 2019-04-12T04:09:19Z

README.md

+
+- `ebcli_installer.py` was previously run, thereby creating `.ebcli-virtual-env` in the user's home directory (or the user's choice of a directory indicated through the `--location` argument). In this case, the EBCLI will simply overwrite `.ebcli-virtual-env` and attempt to install the latest version of the EBCLI in the virtualenv within it.
+
+- `eb` is in `$PATH`, however, it was not installed by `ebcli_installer.py`. In this case, the installer will install `eb` within `.ebcli-virtual-env` in the user's home directory (or the user's choice of a directory indicated through the `--location` argument) and prompt the user to prefix `/path-to/.ebcli-virtual-env/executables` to `$PATH`. Until, this new path is prefixed, the older `eb` will be the primary installation.


The sentence with Until is not very clear as to what it is saying.

jsheld · 2019-04-12T04:13:13Z

README.md

+
+Unfortunately, **yes**.
+
+Suppose the dependencies of `eb`, say `Dep A` and `Dep B` are in conflict, because `pip` lacks dependency management capabilities, the resulting `eb` installation might be rendered defective.


Period after conflict. Then Because

rahulrajaram · 2019-04-16T22:43:09Z

Comments on the README have been addressed here

rahulrajaram added 2 commits April 5, 2019 15:19

Provide a way to install Python and the EBCLI by running a single script

7cf9aac

rahulrajaram self-assigned this Apr 6, 2019

rahulrajaram requested review from jsheld and ChaseAllbee April 6, 2019 00:14

rahulrajaram force-pushed the BundledInstallerForUnix branch from 04cccae to baab077 Compare April 6, 2019 00:46

jsheld reviewed Apr 10, 2019

View reviewed changes

jsheld reviewed Apr 12, 2019

View reviewed changes

jsheld approved these changes Apr 16, 2019

View reviewed changes

rahulrajaram added 4 commits April 16, 2019 16:17

Add README.md

f103294

Add a VERSION file and display the version in the help text

ddd802e

Add a bundled_installer demo to README.md

a1d1784

Fix bug in discovering project root

770391d

rahulrajaram force-pushed the BundledInstallerForUnix branch from 90dc5f6 to 770391d Compare April 16, 2019 23:17

rahulrajaram changed the base branch from AddEBCLIInstaller to master April 16, 2019 23:18

rahulrajaram changed the base branch from master to AddEBCLIInstaller April 16, 2019 23:19

rahulrajaram merged commit ec52c5b into AddEBCLIInstaller Apr 16, 2019

rahulrajaram mentioned this pull request Apr 16, 2019

Bundled installer for unix #6

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bundled installer for unix #5

Bundled installer for unix #5

rahulrajaram commented Apr 6, 2019 •

edited

Loading

jsheld Apr 10, 2019

rahulrajaram Apr 11, 2019

jsheld Apr 10, 2019

rahulrajaram Apr 11, 2019

jsheld Apr 10, 2019

rahulrajaram Apr 11, 2019

jsheld Apr 12, 2019

jsheld Apr 12, 2019

jsheld Apr 12, 2019

jsheld Apr 12, 2019

jsheld Apr 12, 2019

jsheld Apr 12, 2019

jsheld Apr 12, 2019

jsheld Apr 12, 2019

jsheld Apr 12, 2019

jsheld Apr 12, 2019

jsheld Apr 12, 2019

jsheld Apr 12, 2019

jsheld Apr 12, 2019

jsheld Apr 12, 2019

rahulrajaram commented Apr 16, 2019


		The EB CLI is a command line interface for Elastic Beanstalk that provides interactive commands that simplify creating, updating and monitoring environments from a local repository.


		1. create self-contained installations of the EBCLI in a manner that prevents dependency collisions with other related projects such as the AWS CLI.

		2. install the latest Python 3.7 installation


		2. install the latest Python 3.7 installation

		3. combine 2. and 1. for users who do not want to be completely hands-off (recommended).


		### 3. Advanced usage:

		To install the EBCLI, `bundled_installer` runs `ebcli_installer.py`. If you already have Python installed on your system, as will be described later in `4.1.`


		#### 4.2. For the seasoned Python developer, what is the advantage of this mode of installation over regular `pip` inside a `virtualenv`:

		Even within a `virtualenv`, a developer might find the need to install multiple packages whose dependencies are in conflict. For instance, at various points in time, the AWSCLI and the EBCLI have been conflict with one another owing to their dependency on `botocore`. [One such instance](https://github.com/aws/aws-cli/issues/3550) was particularly bad. When there are conflicts, users have to bear the onus of managing separate virtualenvs for each of the conflicting packages, or find a combination of the packages devoid of conflicts. Both these workarounds become unmanageable over time and as the number of packages that are in conflict increases.


		Even within a `virtualenv`, a developer might find the need to install multiple packages whose dependencies are in conflict. For instance, at various points in time, the AWSCLI and the EBCLI have been conflict with one another owing to their dependency on `botocore`. [One such instance](https://github.com/aws/aws-cli/issues/3550) was particularly bad. When there are conflicts, users have to bear the onus of managing separate virtualenvs for each of the conflicting packages, or find a combination of the packages devoid of conflicts. Both these workarounds become unmanageable over time and as the number of packages that are in conflict increases.

		#### 4.3. On OS X (or Linux systems with `brew`), Is this better than `brew install awsebcli`?


		Yes, for a few reasons:

		- the Beanstalk team does not have control over how `brew` operates. So installation problems and will take time to fix as will general queries to be responded to.


		The opinion of the Beanstalk team is "No".

		Besides the problem described in `3.2.`, developers new to Python are often confused by the presence of multiple Pythons, and `pip` executables on their system. A common problem that such developers encounter is where they install `eb` with one `pip` executable (presumably using the `sudo` prefix) only to find that `eb --help` despite repeated installations or any other command does not work because the correct set of directories is not being looked within.


		Normally, for such developers, usage of `virtualenv` is the correct path forward, however, this becomes yet another hurdle before executing with `eb`.

		Another common problem is where, users install Python and `pip` though means not recommended by AWS Documentation such as arbitrary PPAs on Ubuntu, or similar unmaintained sources that lack scrutiny.


		#### 4.4. Can I execute the Bash scripts in a Cygwin, git-bash and other Bash-like shells on Windows?

		No. At this time, we do not directly support execution on Bash-like environments on Windows. Please use PowerShell or CMD Prompt to install. You may add to `$PATH` the location of the `eb` and `Python` executables from your Bash-like terminals.


		- `ebcli_installer.py` was previously run, thereby creating `.ebcli-virtual-env` in the user's home directory (or the user's choice of a directory indicated through the `--location` argument). In this case, the EBCLI will simply overwrite `.ebcli-virtual-env` and attempt to install the latest version of the EBCLI in the virtualenv within it.

		- `eb` is in `$PATH`, however, it was not installed by `ebcli_installer.py`. In this case, the installer will install `eb` within `.ebcli-virtual-env` in the user's home directory (or the user's choice of a directory indicated through the `--location` argument) and prompt the user to prefix `/path-to/.ebcli-virtual-env/executables` to `$PATH`. Until, this new path is prefixed, the older `eb` will be the primary installation.


		Unfortunately, yes.

		Suppose the dependencies of `eb`, say `Dep A` and `Dep B` are in conflict, because `pip` lacks dependency management capabilities, the resulting `eb` installation might be rendered defective.

Bundled installer for unix #5

Bundled installer for unix #5

Conversation

rahulrajaram commented Apr 6, 2019 • edited Loading

1. Description

2. Testing

2.1. python_installer

2.2. bundled_installer

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rahulrajaram commented Apr 16, 2019

rahulrajaram commented Apr 6, 2019 •

edited

Loading

2.1. `python_installer`

2.2. `bundled_installer`