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

Jump to bottom

feat: Make activating Python virtualenv easier on Windows #5014

Merged
merged 8 commits into from
Nov 27, 2019
Merged

feat: Make activating Python virtualenv easier on Windows #5014

merged 8 commits into from
Nov 27, 2019

Conversation

ghost
Copy link

@ghost ghost commented Nov 13, 2019 •
edited by ghost
Loading

The command for activating a Python virtualenv on Linux or Mac OS X is: source .env/bin/activate

The command for doing it on Windows is: .env\Scripts\activate.bat

This PR adds source.bat to our Python templates. It's a simple batch file that lets the Linux/Mac virtualenv activating command work on Windows. That way, when we tell users to activate their virtualenv in documentation, we need only give the Linux/Mac command, and it'll work even on Windows. (Windows cmd.exe doesn't have a source command, so this doesn't block any functionality that Windows users are accustomed to.)

Came up with this idea when working on the Python snippets for the Dev Guide.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

Jerry Kindall added 2 commits November 13, 2019 09:20
Make activating virtualenv easier on Windows
98927db 
The command for activating a Python virtualenv on Linux or Mac OS X is: `source .env/bin/activate`

The command for doing it on Windows is: `.env\Scripts\activate.bat`

This adds `source.bat` to our Python templates. It's a simple batch file that lets the Linux/Mac virtualenv activating command work on Windows. That way, when we tell users to activate their virtualenv in documentation, we need only give the Linux/Mac command, and it'll work even on Windows. (Windows `cmd.exe` doesn't have a `source` command, so this doesn't block any functionality that Windows users are accustomed to.)
Add source.bat to sample-app template as well
ae79887
@ghost ghost requested a review from RomainMuller as a code owner November 13, 2019 17:24
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Nov 13, 2019
@mergify
Copy link
Contributor

mergify bot commented Nov 13, 2019

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist:

  • PR title type(scope): text
    • type: fix, feat, refactor go into CHANGELOG, chore is hidden
    • scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
    • text: use all lower-case, do not end with a period, do not include issue refs
  • PR Description
    • Rationale: describe rationale of change and approach taken
    • Issues: indicate issues fixed via: fixes #xxx or closes #xxx
    • Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
  • Testing
    • Unit test added. Prefer to add a new test rather than modify existing tests
    • CLI or init templates change? Re-run/add CLI integration tests
  • Documentation
    • README: update module README to describe new features
    • API docs: public APIs must be documented. Copy from official AWS docs when possible
    • Design: for significant features, follow design process

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@ghost ghost changed the title Make activating virtualenv easier on Windows improvement: Make activating virtualenv easier on Windows Nov 13, 2019
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@jakerullman
Copy link
Contributor

I think this is a nice quality-of-life improvement. As long as there is no conflict with existing Windows interactions and we make it clear to the user what is actually happening, I think this will make a positive change to reduce user friction.

@ghost
Copy link
Author

ghost commented Nov 14, 2019

@jakerullman I could add an echo to display the command actually being executed, if you think that might help out.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@jakerullman
Copy link
Contributor

@jerry-aws That's a good idea, I think displaying the command actually being run would remove any potential user confusion.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@ghost ghost changed the title improvement: Make activating virtualenv easier on Windows feat: Make activating Python virtualenv easier on Windows Nov 25, 2019
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify
Copy link
Contributor

mergify bot commented Nov 27, 2019

Thank you for contributing! Your pull request is now being automatically merged.

@mergify mergify bot merged commit fc73747 into master Nov 27, 2019
@mergify mergify bot deleted the Jerry-AWS-python-easier-venv branch November 27, 2019 19:12
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shivlaks shivlaks Awaiting requested review from shivlaks

Assignees

@RomainMuller RomainMuller

@shivlaks shivlaks

Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@aws-cdk-automation @jakerullman @RomainMuller @shivlaks