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

Move code from bin/codebasin to __main__.py #111

Merged
merged 1 commit into from
Sep 19, 2024

Conversation

Pennycook
Copy link
Contributor

This simple change provides several improvements:

  • The codebasin script can be generated by pyproject.toml.
  • codebasin can now be invoked as python -m codebasin.
  • Editable installs now reflect changes to the command-line interface.

Moving the command-line code into the codebasin/ package should also make it easier to test command-line functionality with unit tests, but this commit does not make any such changes.

Related issues

N/A

Proposed changes

  • Move bin/codebasin to codebasin/main.py.
  • Configure pyproject.toml to generate and install a codebasin script.

This simple change provides several improvements:

- The codebasin script can be generated by pyproject.toml.
- codebasin can now be invoked as python -m codebasin.
- Editable installs now reflect changes to the command-line interface.

Moving the command-line code into the codebasin/ package should also
make it easier to test command-line functionality with unit tests, but
this commit does not make any such changes.

Signed-off-by: John Pennycook <john.pennycook@intel.com>
@Pennycook Pennycook added the enhancement New feature or request label Sep 12, 2024
@Pennycook Pennycook added this to the 2.0.0 milestone Sep 12, 2024
Copy link
Contributor

@laserkelvin laserkelvin left a comment

Choose a reason for hiding this comment

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

LGTM

@Pennycook Pennycook merged commit e82298a into intel:main Sep 19, 2024
3 checks passed
@Pennycook Pennycook deleted the main-script branch September 19, 2024 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants