Repository navigation
Conversation
C-Achard
commented
Nov 4, 2026
C-Achard
commented
Contributor
- Introduced license options: Apache-2.0, MIT, and BSD-3-Clause.
- Updated CLI to prompt for license selection and include it in generated files.
- Modified README, pyproject.toml, and myst.yml templates to reflect chosen license.
- Added LICENSE files for MIT and BSD-3-Clause.
- Tests to verify license functionality and defaults.
C-Achard
force-pushed
the
cy/license-picker
branch
from
November 4, 2026 10:39
9daab08 to
d7413d0
Compare
- Introduced license options: Apache-2.0, MIT, and BSD-3-Clause. - Updated CLI to prompt for license selection and include it in generated files. - Modified README, pyproject.toml, and myst.yml templates to reflect chosen license. - Added LICENSE files for MIT and BSD-3-Clause. - Enhanced tests to verify license functionality and defaults.
C-Achard
force-pushed
the
cy/license-picker
branch
from
November 4, 2026 15:26
d7413d0 to
f8026ba
Compare
There was a problem hiding this comment.
🟡 Changes recommended
The license-selection wording is ambiguous because it presents --license as a fourth license rather than a flag for choosing one of the three licenses.
1 open issue
What changed in this PR
Adds license selection to the project generator, keeping generated license text, package metadata, and documentation aligned.
Changes:
- Supports Apache-2.0, MIT, and BSD-3-Clause through an interactive prompt or
--license, with Apache-2.0 as the default. - Adds license-specific files and fills in the year and author for MIT and BSD-3-Clause.
- Documents selection and adds tests for license propagation, defaults, and invalid choices.
| File | Description |
|---|---|
tests/test_cli.py |
Tests license selection, generated content, defaults, and rejection of unsupported choices. |
src/scene_repo_template/skeleton/licenses/MIT/LICENSE.tmpl |
Adds MIT text with year and author placeholders. |
src/scene_repo_template/skeleton/licenses/BSD-3-Clause/LICENSE.tmpl |
Adds BSD-3-Clause text with copyright placeholders. |
src/scene_repo_template/skeleton/licenses/Apache-2.0/LICENSE |
Supplies Apache-2.0 text for license-specific generation. |
src/scene_repo_template/skeleton/jupyter-book/docs/myst.yml.tmpl |
Uses the selected license in Jupyter Book metadata. |
src/scene_repo_template/skeleton/common/README.md.tmpl |
Names the selected license in generated READMEs. |
src/scene_repo_template/skeleton/common/pyproject.toml.tmpl |
Sets package metadata to the selected license. |
src/scene_repo_template/cli.py |
Adds license choices, shared choice prompting, and license-file generation. |
docs/guides/using-the-template.md |
Explains supported licenses and how to change them. |
Review effort: Balanced
|
|
||
| Projects start with Apache-2.0. | ||
| To change it, replace `LICENSE` and update every place that names the license: | ||
| The template supports Apache-2.0 (the default), MIT or BSD-3-Clause, or `--license`. |
This branch has not been deployed
This file contains hidden or 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
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.