Improve project installation procedure #38
Merged
Conversation
This file contains 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
…lists. - Move requirements.txt to top level project dir - Modify README installation instructions to account for `setup.py` method - Modify GitHub workflow to account for new `requirements.txt` location - Modify CLI args to improve wording, capitalization uniformity
AustinCullar
added
documentation
AustinCullar
deleted the
35-remove-requirementstxt-if-no-longer-required-with-setuppy
branch
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.
I've kept both the
setup.pyandrequirements.txtfiles, but moved them to the project root directory.setup.pywill provide an easy means of project installation, along with an option for developers to install required development/test packages.requirements.txtwill provide a list of all packages used in the my development virtual environment. This can provide a safety net if a developer finds thatpip install -e .does not properly setup their development environment, as they can then runpip install -r requirements.txtto fully mirror my development environment.