-
Notifications
You must be signed in to change notification settings - Fork 18
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
Rewrite README instructions to use pipx #84
Merged
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
sierra-moxon
reviewed
Dec 1, 2023
@@ -58,11 +58,10 @@ status: check-config | |||
@echo "Source: $(SOURCE_SCHEMA_PATH)" | |||
|
|||
# generate products and add everything to github | |||
setup: install gen-project gen-examples gendoc git-init-add | |||
setup: git-init install gen-project gen-examples gendoc git-add git-commit |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thank you!
sierra-moxon
approved these changes
Dec 1, 2023
hrshdhgd
approved these changes
Dec 1, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Were we not doing recommit hooks in this cookiecutter?
- Do we want to include that here or some other time (different PR).
I guess we're not at the moment. It's not a bad idea, but let's make a new issue for that. |
This was referenced Dec 2, 2023
Closed
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.
Fixes #81
Mainly this is updating the
README
to give instructions on getting set up usingpipx
instead of creating the "wrapper" Poetry environment.While making sure that everything in the
README
works out of the box I made two additional changes:Makefile
targets so that there are no uncommitted files still hanging around after the initial commitgit-init
target frominstall
and added it tosetup
. There are valid reasons you might want to runmake install
again later and you don't want to callgit init
at that point.make deploy
from theREADME
. I don't think we want to encourage people doing this manually especially since we have a GitHub Action that does it.