Allow rename script to work properly. #28
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
- address bug where rename script causes program to break. - better follow convention.
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.
Previously, the rename script would error when trying to rename the my_project_name dir. All the imports would get renamed, which would break any project built off the template.
These issues appear to be caused by the rename script attempting to rename both the main script file (referenced in setup.py) and the script source dir to the same new name. Specifically calling out a distinct name in all places referencing the script file resolves the issue.
The issue this PR resolves does need to be addressed but it does not necessary need to be resolved this way. I chose to rename the script file rather than making an exception in the rename script itself since the ctl suffix is standard across many tools that expose a script to the end user. Notable in the Matrix ecosystem, Synapse does this.