- Notifications
You must be signed in to change notification settings - Fork5.7k
Rework Repository tosrc Layout#4798
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:master
Are you sure you want to change the base?
Conversation
Bibo-Joshi commentedMay 23, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
About6c7cf83: I've done this now like I did forchango. I'm not sure though if that's the best way. Note that the source distribution now includes many more files than before. If anyone has suggsetions on best practices, I'm happy for input. Installing from these distributions works, though, I've tested that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Pull Request Overview
This PR reworks the repository layout to use a src-based structure, moving package code from telegram to src/telegram.
- Update configuration in pyproject.toml for versioning, builds, linting, testing, and type checking.
- Adjust CI workflows to use the new src/telegram path.
- Update contribution documentation to reflect the new layout.
Reviewed Changes
Copilot reviewed 232 out of 232 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Updated package paths and build configurations |
| changes/unreleased/4798.g7G3jRf2ns4ath9LRFEcit.toml | Added changelog entry for the repository rework |
| .github/workflows/unit_tests.yml | Updated test path to src/telegram |
| .github/workflows/type_completeness.yml | Updated test path to src/telegram |
| .github/workflows/test_official.yml | Updated test path to src/telegram |
| .github/workflows/docs-admonitions.yml | Updated test path to src/telegram |
| .github/CONTRIBUTING.rst | Extended instructions to reflect the new src layout |
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
If anyone has suggsetions on best practices
I couldn't find any document outlining what files should be in a sdist,this document mentions that a pyproject.toml andPKG-INFO file must be present, but otherwise makes no recommendations. I think we can keep pretty much everything then.
I didn't see any updates to docs related files, and the builds are passing, so I assume that works fine and sphinx can see the files.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
When readycloses#4797
Needs manual verification that
I totally just let GH Copilot Agent run for 10 minutes and just manually fixed a few obvious things in the diff 😅