feat: properly include README and config.yaml.example in package (Fixes #32) - #34
Merged
Conversation
- 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 Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
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
Ensure that README.md and config.yaml.example are included in the built package distribution and accessible in installed package:
Changes
MANIFEST.into include README.md, LICENSE, and config.yaml.exampleconfig.yaml.exampletoemail_processor/package directoryREADME.mdtoemail_processor/package directorypackage-datainpyproject.tomlto include files in packageemail_processor/cli/commands/config.pyto find config.yaml.example in package usingimportlib.resourcesTesting
Checklist
Note: Files are now included in the package directory and accessible via
importlib.resourcesafter installation.Fixes #32