Skip to content

Conversation

@JeremieGince
Copy link
Owner

@JeremieGince JeremieGince commented Jul 8, 2025

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:

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:
    • Removed redundant version-related content modification in update_pyproject_toml function.
    • Added support for updating the __package__ attribute in the update_init_file function.
    • Refined the update_readme_md function to replace the default project name with the user-specified project name.

Dependency Version Adjustment:

  • pyproject.toml: Updated pythonbasictools dependency from >=0.0.1a11 to >=0.0.3 for 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.

  • All new features include a unit test.
    Make sure that the tests passed and the coverage is
    sufficient by running python run_pytests.py --tests_folder=tests or
    pytest tests --cov=src --cov-report=term-missing.
  • All new functions and code are clearly documented.
  • The code is formatted using Black.
    You can do this by running black src tests.
  • The imports are sorted using isort.
    You can do this by running isort src tests.
  • The code is type-checked using Mypy.
    You can do this by running mypy src tests.

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.
@github-actions
Copy link
Contributor

github-actions bot commented Jul 8, 2025

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
21 21 100% 98% 🟢

New Files

No new covered files...

Modified Files

No covered modified files...

updated for commit: 03cc6df by action🐍

@JeremieGince JeremieGince merged commit 715c2c0 into main Jul 8, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants