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

584-allow uppercase in package name #613

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Conversation

fdiblen
Copy link
Member

@fdiblen fdiblen commented Aug 28, 2024

Checklist before requesting a review

  • I have read the contribution guidelines
  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • All user facing changes have been added to CHANGELOG.md

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

List of related issues or pull requests**

Refs:

Describe the changes made in this pull request

Package names containing uppercase are allowed.

Instructions to review the pull request

Install the requirements

cd $(mktemp -d --tmpdir py-tmpl-XXXXXX)
pip install pipx
pipx install copier

Create a new package using the template

copier copy --vcs-ref <YOUR_BRANCH> https://github.com/nlesc/python-template test_package

Create a local git repo to push to GitHub to trigger CI actions

git init
git add --all
git commit -m "First commit"
git remote add origin git@github.com:<YOU>/python-template-test.git
git push -u origin main -f
# Create a local environment to test your generated package locally
python -m venv env
source env/bin/activate
python -m pip install --upgrade pip setuptools
python -m pip install '.[dev,publishing]'

@fdiblen fdiblen marked this pull request as ready for review August 28, 2024 09:34
@lyashevska
Copy link
Member

Type of change is not selected in the description of this PR.

@lyashevska lyashevska self-requested a review August 28, 2024 10:43
@@ -10,13 +10,17 @@
* Make contributing guidelines optional [#465](https://github.com/NLeSC/python-template/pull/465)
* Make developer documentation optional [#467](https://github.com/NLeSC/python-template/pull/541)
* Make Code of Conduct optional [#464](https://github.com/NLeSC/python-template/pull/530)
* CHANGELOG.md is now optional ([#462](https://github.com/NLeSC/python-template/issues/462))
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* CHANGELOG.md is now optional ([#462](https://github.com/NLeSC/python-template/issues/462))
* CHANGELOG.md is now optional [#462](https://github.com/NLeSC/python-template/issues/462)

@@ -10,13 +10,17 @@
* Make contributing guidelines optional [#465](https://github.com/NLeSC/python-template/pull/465)
* Make developer documentation optional [#467](https://github.com/NLeSC/python-template/pull/541)
* Make Code of Conduct optional [#464](https://github.com/NLeSC/python-template/pull/530)
* CHANGELOG.md is now optional ([#462](https://github.com/NLeSC/python-template/issues/462))
* pre-commit script is optional ([#457](https://github.com/NLeSC/python-template/issues/457))
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* pre-commit script is optional ([#457](https://github.com/NLeSC/python-template/issues/457))
* pre-commit script is optional [#457](https://github.com/NLeSC/python-template/issues/457)

@@ -5,7 +5,7 @@ package_name:
placeholder: my_python_package
help: Enter the name of the Python package.
validator: >-
{% if not (package_name | regex_search('^[a-z][a-z0-9\_]+$')) %}
{% if not (package_name | regex_search('^[A-Za-z][A-Za-z0-9\_]+$')) %}
Package name must start with a letter, followed one or more letters, digits or underscores all lowercase
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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

Copy link
Member

@lyashevska lyashevska left a comment

Choose a reason for hiding this comment

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

thanks @fdiblen See a couple of comments. After that good to go.

@fdiblen
Copy link
Member Author

fdiblen commented Aug 28, 2024

blocked by #621

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants