Merged
Conversation
Replaced the code coverage badge with a Black code style badge in the README to highlight code formatting standards.
Modified build commands in GitHub workflows to use explicit build options for sdist and wheel, disable isolation, and specify output directory. Updated pyproject.toml to require pythonbasictools version >=0.0.3.
Added isort badge to README.md. In change_project_attributes.py, removed redundant version update logic, fixed a typo in 'package_name' argument handling, and improved README project name replacement.
Removed the custom run_pytests.py script and updated the GitHub Actions workflow to invoke pytest directly with coverage and parallelization options. This simplifies the test execution process and reduces maintenance overhead.
Contributor
☂️ Python Coverage
Overall Coverage
New FilesNo new covered files... Modified FilesNo covered modified files...
|
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.
Description
This pull request includes updates to the build workflows, documentation, and project attribute modification scripts, as well as dependency version adjustments. The most important changes focus on improving build processes, enhancing documentation, and refining project configuration scripts.
Build Workflow Enhancements:
.github/workflows/build_dist.yml: Updated thepython -m buildcommand to include--sdist --wheel --no-isolation --outdir dist/ .for more robust distribution builds..github/workflows/tests.yml: Applied the same update to thepython -m buildcommand in the test workflow for consistency.Documentation Improvements:
README.md: Replaced the code coverage badge with badges for code style (black) and import sorting (isort) to better reflect project standards.Project Attribute Updates:
change_project_attributes.py:update_pyproject_tomlfunction.__package__attribute in theupdate_init_filefunction.update_readme_mdfunction to replace the default project name with the user-specified project name.Dependency Version Adjustment:
pyproject.toml: Updatedpythonbasictoolsdependency from>=0.0.1a11to>=0.0.3for improved compatibility and functionality.Checklist
Please complete the following checklist when submitting a PR. The PR will not be reviewed until all items are checked.
Make sure that the tests passed and the coverage is
sufficient by running
python run_pytests.py --tests_folder=testsorpytest tests --cov=src --cov-report=term-missing.You can do this by running
black src tests.You can do this by running
isort src tests.You can do this by running
mypy src tests.