Skip to content

feat: include README and config.yaml.example in package build (Fixes #32) - #33

Merged
KHolodilin merged 3 commits into
mainfrom
feature/issue-32-package-files
Jan 26, 2026
Merged

feat: include README and config.yaml.example in package build (Fixes #32)#33
KHolodilin merged 3 commits into
mainfrom
feature/issue-32-package-files

Conversation

@KHolodilin

Copy link
Copy Markdown
Owner

Description

Ensure that README.md and config.yaml.example are included in the built package distribution:

  1. Verify that README.md is correctly included (already configured in pyproject.toml)
  2. Add config.yaml.example to package distribution via MANIFEST.in
  3. This ensures users have access to documentation and example configuration after installation

Changes

  • Created MANIFEST.in to include README.md, LICENSE, and config.yaml.example
  • Updated email_processor/cli/commands/config.py to support finding config.yaml.example
  • Bumped version to 8.0.5

Testing

  • ✅ All tests pass
  • ✅ MANIFEST.in created with required files
  • ✅ Config command updated to support package file lookup

Checklist

  • MANIFEST.in created
  • Config.py updated
  • Tests pass
  • Version bumped (8.0.4 → 8.0.5)
  • Code committed
  • Branch pushed

Note: Files from MANIFEST.in are included in .dist-info directory. README.md is shown on PyPI, and config.yaml.example will be available in the package distribution.

Fixes #32

- Add MANIFEST.in to include README.md, LICENSE, and config.yaml.example
- Update config.py to support finding config.yaml.example
- Ensures users have access to documentation and example config after installation
- Bump version to 8.0.5

Fixes #32
- Resolved version conflicts (kept 8.0.5 for this branch)
- Merged latest changes from main
@codecov-commenter

codecov-commenter commented Jan 26, 2026

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

- Remove unused importlib.resources import
- Fixes ruff check error
@KHolodilin
KHolodilin merged commit ceddb9b into main Jan 26, 2026
18 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.

Include README.md and config.yaml.example in package distribution

2 participants