Package review fixes#1
Merged
Merged
Conversation
…rker for type checker support\n- Add __version__ via importlib.metadata to __init__.py\n- Add Homepage URL to pyproject.toml [project.urls]\n- Update plan Task Index (tasks 0-2 done)"
…mandatory gate task (⏩ Phase N Summary) as last row of every phase\n in the Task Index — makes phase summary a tracked deliverable, not just a callout\n- Replace⚠️ phase-end callouts with self-contained 🛑 callouts that inline\n all 3 required steps (run tests, write summary, commit separately)\n- Add Rule 5 to Phase Guidelines explaining gate task format and purpose\n- Update canonical Task Index example with gate task rows\n- Retrofit existing package-review-fixes-plan.md with new pattern"
…Add Phase Summary Gate Task Template section with verbatim copy-paste\n block that plan authors insert as the last task in every phase\n- Gate tasks now have their own ### heading and 5-step checklist\n (run tests, run lint, write summary, mark done, commit)\n- Replace blockquote callouts with full task detail sections\n- Simplify After Completing a Phase to point at the template\n- Retrofit package-review-fixes-plan.md with new format"
… hint, remove README duplicate line
|
Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits. |
There was a problem hiding this comment.
Pull request overview
This PR addresses packaging and quality issues identified during the PyPI package review for bosos-dev-tools, improving distribution metadata, runtime behavior, documentation, CI coverage, and test coverage across CLI entry points and logging utilities.
Changes:
- Adds typed-package and metadata improvements (
py.typed,__version__, PyPIHomepageURL). - Adjusts runtime behavior and API docs (notably
timing_decoratoroutput gating;progress_bartyping update). - Expands tests and CI (subprocess
python -m ...tests; broader OS/Python matrix) and updates documentation/changelog.
Reviewed changes
Copilot reviewed 13 out of 14 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
src/tests/test_md_link_checker.py |
Adds subprocess tests for python -m dev_tools.md_link_checker. |
src/tests/test_codemap_generator.py |
Adds subprocess tests for python -m dev_tools.codemap_generator. |
src/tests/test_logger_settings.py |
Adds tests for additional logger_settings branches/utilities. |
src/tests/test_custom_decorators.py |
Updates tests for timing_decorator behavior when TIMING is on/off. |
src/dev_tools/progress_bar.py |
Updates type hints/docs to reflect len() requirement. |
src/dev_tools/custom_decorators.py |
Changes timing_decorator to only print/log when TIMING is enabled; updates docstring. |
src/dev_tools/cli_help.py |
Updates CLI/API help text to reflect the timing behavior change. |
src/dev_tools/__init__.py |
Adds __version__ and exports it via __all__. |
src/dev_tools/py.typed |
Adds PEP 561 marker file for typed-package support. |
pyproject.toml |
Adds Homepage URL to project metadata. |
.github/workflows/test.yml |
Expands test matrix to additional OS targets. |
README.md |
Documents logging config discovery/fallback; removes duplicate env var row. |
CHANGELOG.md |
Documents the set of package-review fixes under Unreleased. |
docs/ai-context/planning-instructions.md |
Refines phase summary “gate task” protocol/template. |
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment Thanks for integrating Codecov - We've got you covered ☂️ |
Contributor
Contributor
Co-authored-by: bjorngun <47886783+bjorngun@users.noreply.github.com>
…, fix return type
Fix `progress_bar` return type annotation: `Collection` → `Iterator[T]`
bjorngun
force-pushed
the
package-review-fixes
branch
2 times, most recently
from
85d1220 to
025b230
Compare
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.
Package Review Fixes
Addresses all issues identified in the pip package review of
bosos-dev-toolsv1.0.1.Packaging Metadata
py.typedPEP 561 marker for type checker support__version__attribute viaimportlib.metadataHomepageURL to PyPI project metadataCode Quality
timing_decoratorno longer prints by default — requiresTIMING=Trueprogress_bartype hint fromIterabletoCollection(reflectslen()requirement)LOGGER_DAY_SPECIFICrow from READMETest Coverage
python -m dev_tools.md_link_checkerandpython -m dev_tools.codemap_generatorlogger_settings.pycoverage:is_logs_sorted_by_days(),log_exit_code(), error paths, debug-mode branch,_default_logging_config()CI & Documentation
publish.ymltriggered byrelease: [published]— fixes PR merges not publishing to PyPIlogging.confdiscovery and fallback behavior in READMEcli_help.pyto reflecttiming_decoratorbehavioral change