Skip to content

Change license.file to license-files + SPDX-compliance #528

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.

Sign up for GitHub

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

Merged
matt-graham merged 5 commits into from
Apr 3, 2025
Merged

Change license.file to license-files + SPDX-compliance #528

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f170962
Change `license.file` to `license-files`
paddyroddy Apr 2, 2025
9d21a88
Fix test
paddyroddy Apr 2, 2025
28a36de
Add `license` field to test
paddyroddy Apr 2, 2025
6e2a2c8
Add `license` to top level pyproject
paddyroddy Apr 2, 2025
6a85dc1
Rename `BSD-3` to be SPDX-compliant
paddyroddy Apr 2, 2025
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
2 changes: 1 addition & 1 deletion cookiecutter.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"github_owner": "{{cookiecutter.author_given_names.lower().replace(' ', '-')}}-{{cookiecutter.author_family_names.lower().replace(' ', '-')}}",
"min_python_version": ["3.11", "3.12", "3.13"],
"max_python_version": ["3.13", "3.12", "3.11"],
"license": ["MIT", "BSD-3", "GPL-3.0"],
"license": ["MIT", "BSD-3-Clause", "GPL-3.0"],
"funder": "",
"__repo_name": "{{cookiecutter.github_owner}}/{{cookiecutter.project_slug}}",
"__repo_url": "https://github.com/{{cookiecutter.__repo_name}}",
Expand Down
5 changes: 4 additions & 1 deletion tests/data/test_package_generation/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ dynamic = [
]
keywords = [
]
license = "MIT"
license-files = [
"LICENSE.md",
]
name = "cookiecutter-test"
optional-dependencies = {dev = [
"build",
Expand All @@ -46,7 +50,6 @@ optional-dependencies = {dev = [
]}
readme = "README.md"
requires-python = ">=3.11"
license.file = "LICENSE.md"
urls.homepage = "https://github.com/test-user/cookiecutter-test"

[tool.coverage]
Expand Down
2 changes: 1 addition & 1 deletion {{cookiecutter.project_slug}}/LICENSE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

{%- elif cookiecutter.license == "BSD-3" -%}
{%- elif cookiecutter.license == "BSD-3-Clause" -%}

Copyright (c) {% now 'utc', '%Y' %}, {{cookiecutter.author_given_names}}
{{cookiecutter.author_family_names}} All rights reserved.
Expand Down
2 changes: 1 addition & 1 deletion {{cookiecutter.project_slug}}/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
[documentation-link]: {{cookiecutter.__repo_url}}/actions/workflows/docs.yml
{%- if cookiecutter.license == "MIT" %}
[license-badge]: https://img.shields.io/badge/License-MIT-yellow.svg
{%- elif cookiecutter.license == "BSD-3" %}
{%- elif cookiecutter.license == "BSD-3-Clause" %}
[license-badge]: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg
{%- elif cookiecutter.license == "GPL-3.0" %}
[license-badge]: https://img.shields.io/badge/License-GPLv3-blue.svg
Expand Down
5 changes: 4 additions & 1 deletion {{cookiecutter.project_slug}}/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ dynamic = [
]
keywords = [
]
license = "{{cookiecutter.license}}"
license-files = [
"LICENSE.md",
]
name = "{{cookiecutter.project_slug}}"
optional-dependencies = {dev = [
"build",
Expand All @@ -49,7 +53,6 @@ optional-dependencies = {dev = [
]}
readme = "README.md"
requires-python = ">={{cookiecutter.min_python_version}}"
license.file = "LICENSE.md"
urls.homepage = "{{cookiecutter.__repo_url}}"

[tool.coverage]
Expand Down