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.

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

Rename template folder and files in preparation of migration to copier #411

Merged
merged 1 commit into from
Aug 1, 2024

Conversation

lyashevska
Copy link
Member

Description

In copier directory_name is not being asked anymore because copier copy source destination generates it. It was replaced by either template to refer to the location or package_name to construct the github links. This means that package_name is now also the name of the repo.

Related issues:

@lyashevska lyashevska requested a review from sjvrijn August 1, 2024 09:35
Copy link
Contributor

@sjvrijn sjvrijn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just two small remarks. Tests pass for me locally conditional on #408 👍

README.md Outdated Show resolved Hide resolved
copier.yml Outdated
@@ -6,15 +6,15 @@ package_name:
help: Enter the name of the Python package.
validator: >-
{% if not (package_name | regex_search('^[a-z][a-z0-9\_]+$')) %}
package_name must start with a letter, followed one or more letters, digits or underscores all lowercase.
package_name must start with a letter, followed one or more letters, digits or underscores all lowercase. Avoid using spaces or uppercase letters for the best experience across operating systems.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to make this consistent with the README by also specifying to avoid dashes, i.e., 'Avoid using spaces, dashes or uppercase letters [...]'?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This came from the README :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But good point!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a restriction, as user is not allowed to use any of that. Shall we get rid of it altogher?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The directory_name explanation indeed did not mention dashes, I was looking at the explanation for package_name, which does suggest avoiding them. Either way, I agree that removing it even better since it's not allowed anyway 👍

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your review @sjvrijn. I have made changes and updated branch. This can be merged now.

@lyashevska lyashevska merged commit a9ad311 into dev Aug 1, 2024
@lyashevska lyashevska deleted the 403-handle-directory_name branch August 1, 2024 11:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants