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
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

* 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)

* New YAML files for copier questions [#529](https://github.com/NLeSC/python-template/pull/529)
* Make zenodo next step instructions optional [#520](https://github.com/NLeSC/python-template/pull/520)
* Make SonarCloud optional [#515](https://github.com/NLeSC/python-template/pull/515)
* Make citation optional [#471](https://github.com/NLeSC/python-template/pull/471)
* Make online documentation optional [#476](https://github.com/NLeSC/python-template/pull/476)

### Changed
* Made copier configuration more modular [#529](https://github.com/NLeSC/python-template/pull/529)
* Allow uppercase in package name [#613](https://github.com/NLeSC/python-template/pull/613)
* next_steps.md is shown as a copier message [#609](https://github.com/NLeSC/python-template/pull/609)
* Change the default profile to 'recommended' [#598](https://github.com/NLeSC/python-template/pull/598)
* Updated the user documentation (README.md) of the template [#569](https://github.com/NLeSC/python-template/pull/569)
Expand All @@ -33,7 +37,6 @@
Released on August 15, 2024

### Added

* Added Python 3.12 support [#356](https://github.com/NLeSC/python-template/issues/356)
* Template unit tests for documentation generation, linting and version bumping
* Docstring for function
Expand All @@ -42,10 +45,6 @@ Released on August 15, 2024
* Added new 'docs' section in extra dependencies [#317](https://github.com/NLeSC/python-template/issues/317)

### Changed

* Made copier configuration more modular [#529](https://github.com/NLeSC/python-template/pull/529)
* pre-commit script is optional ([#457](https://github.com/NLeSC/python-template/issues/457))
* CHANGELOG.md is now optional ([#462](https://github.com/NLeSC/python-template/issues/462))
* Moved to src/ based layout for generated packages
* Moved from setup.cfg/.py to pyproject.toml [#351](https://github.com/NLeSC/python-template/issues/351)
* Moved from prospector to ruff [#336](https://github.com/NLeSC/python-template/issues/336)
Expand Down
2 changes: 1 addition & 1 deletion copier/questions/essential.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

{% endif %}
version:
Expand Down