Add Pipfile to support Pipenv for development #710
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #710 +/- ##
=======================================
Coverage 96.03% 96.03%
=======================================
Files 12 12
Lines 3356 3356
=======================================
Hits 3223 3223
Misses 133 133Continue to review full report at Codecov.
|
kotfu
requested changes
Jul 6, 2019
Member
kotfu
left a comment
kotfu
left a comment
There was a problem hiding this comment.
I suggest adding a note to CONTRIBUTING saying we have support for pipenv. You can probably just take the second half of the text from the body of the PR and paste it into a new section in CONTRIBUTING and call it good.
Also: - Made various other updates to CONTRIBUTING.md
…nt it taking a long time when using a venv
Member
Author
|
I added a section to CONTRIBUTING.md with info on our support for |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a Pipfile for using Pipenv for development.
Pipenvessentially combines the features ofpipandvirtualenvinto a single tool. Adding this Pipfile makes it extremely easy to setup acmd2development environment usingpipenv.Also:
Pipfile.lockand.venvto .gitignore sincecmd2is a library, not an application and as such we do not intend to usepipenvfor deployment purposes, only developmentpylintwithflake8in the dev section since we are usingflake8for linting as part of our CI processPipenvflake8to exclude unnecessary directories so thatflake8doesn't take forever when using a virtual environment embedded in thecmd2directoryTo create a virtual environment and install everything needed for
cmd2development, do the following from a GitHub checkout:To create a new virtualenv, using a specific version of Python you have installed (and on your PATH), use the --python VERSION flag, like so:
Then you can enter that virtual environment with: