Skip to content

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

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

feat: properly include README and config.yaml.example in package (Fixes #32)#34
KHolodilin merged 2 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 and accessible in installed package:

  1. Add config.yaml.example to email_processor package directory
  2. Add README.md to email_processor package directory
  3. Configure package-data in pyproject.toml
  4. Update config.py to find config.yaml.example in package using importlib.resources
  5. Keep MANIFEST.in for additional files (LICENSE)

Changes

  • Created MANIFEST.in to include README.md, LICENSE, and config.yaml.example
  • Added config.yaml.example to email_processor/ package directory
  • Added README.md to email_processor/ package directory
  • Configured package-data in pyproject.toml to include files in package
  • Updated email_processor/cli/commands/config.py to find config.yaml.example in package using importlib.resources
  • Applied pre-commit fixes (line endings)
  • Bumped version to 8.0.5

Testing

  • ✅ All tests pass (763 tests)
  • ✅ Pre-commit checks pass
  • ✅ Ruff check passes
  • ✅ MANIFEST.in created with required files
  • ✅ Package data configured correctly
  • ✅ Config command updated to support package file lookup

Checklist

  • MANIFEST.in created
  • config.yaml.example added to package
  • README.md added to package
  • package-data configured in pyproject.toml
  • Config.py updated with importlib.resources
  • All tests pass
  • Pre-commit checks pass
  • Version bumped (8.0.4 → 8.0.5)
  • Code committed
  • Branch pushed

Note: Files are now included in the package directory and accessible via importlib.resources after installation.

Fixes #32

- Add config.yaml.example to email_processor package directory
- Configure package-data in pyproject.toml to include config.yaml.example
- Update config.py to find config.yaml.example in package using importlib.resources
- Keep MANIFEST.in for additional files (README.md, LICENSE)
- Files are now accessible in installed package

Fixes #32
- Add README.md to email_processor package directory
- Update package-data to include README.md
- README.md is now accessible in installed package

Fixes #32
@codecov-commenter

Copy link
Copy Markdown

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

Codecov Report

❌ Patch coverage is 72.72727% with 3 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
email_processor/cli/commands/config.py 72.72% 3 Missing ⚠️

📢 Thoughts on this report? Let us know!

@KHolodilin
KHolodilin merged commit f742975 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