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 pipx as installation option #135

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

Conversation

adehad
Copy link

@adehad adehad commented Aug 28, 2022

Description of changes:

  1. Propose the usage of pipx, a PyPA supported way to install executables in an isolated virtual environment.

It is likely that this method obsoletes the scripts in this repository.

Contributor suggestion

As mentioned in section 5.5:

https://github.com/aws/aws-elastic-beanstalk-cli-setup/blob/6b2d6646c728e9ccfc6bb482926bb6ba5451c322/README.md#55-are-there-dependency-problems-that-this-mode-of-installation-doesnt-solve

It is possible for the dependencies of awsebcli to conflict.

A suggestion I have is to use the --pip-args argument, to add a --constraint to the dependencies installed.

Example constraints.txt file:

awsebcli==3.20.3
botocore==1.23.54
cement==2.8.2
certifi==2022.6.15
charset-normalizer==2.0.12
colorama==0.4.3
future==0.16.0
idna==3.3
jmespath==0.10.0
pathspec==0.9.0
pypiwin32==223
python-dateutil==2.8.2
pywin32==304
PyYAML==5.4.1
requests==2.26.0
semantic-version==2.8.5
six==1.14.0
termcolor==1.1.0
urllib3==1.26.12
wcwidth==0.1.9

Example usage of constraints file located from github:

pipx install awsebcli --pip-args "--constraint https://raw.githubusercontent.com/pycontribs/jira/main/constraints.txt

NOTE:

  1. Here I have used the constraints.txt from another repository, but if this approach is considered for this package it should exist within this repository.
  2. Using this file would mean that the file needs to be updated every single time awsebcli is updated, as its version contained in the constrained dependencies above. But we can simple omit entries we do not want constrained and only update other dependencies when there are breaking changes, e.g. lock packages that are not under AWS control and only bump their versions when it would conflict with the AWS owned awsebcli or botocore pakckages.

Issue #, if available:

N/A

Agreement:

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


```shell
python -m pip install pipx

Copy link
Author

Choose a reason for hiding this comment

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

Suggested change
pipx ensurepath

can be added for completeness if we want to match the installation instructions from the pipx docs: https://pypa.github.io/pipx/installation/

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.

1 participant