Skip to content

Include documentation, tests and auxiliary files in sdist - #17

Merged
kurtmckee merged 1 commit into
python-syndication:mainfrom
mgorny:sdist
Jul 30, 2026
Merged

Include documentation, tests and auxiliary files in sdist#17
kurtmckee merged 1 commit into
python-syndication:mainfrom
mgorny:sdist

Conversation

@mgorny

@mgorny mgorny commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Fixes #12

Fixes python-syndication#12

Signed-off-by: Michał Górny <mgorny@gentoo.org>
@mgorny
mgorny requested a review from kurtmckee as a code owner July 30, 2026 16:06

@kurtmckee kurtmckee left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested locally:

gh co 17
tox -e build

# Copy sdist filename
# In an isolated directory:

tar -xzf $SDIST_FILENAME
cd feedparser_sgmllib-2.0.0
tox p

git init
git status

The package built, tox ran without issue, and things look good!

I'd like to ask for your opinion, based on your experience: the sdist contains a file named PKG-INFO, which shows up in the git status output. Should this file be added to .gitignore?

I don't have experience in this area, so I'm hopeful you can speak to this. If it should be added, let's add it in this PR. If you know it should NOT be added, or you don't have an opinion for your use case, I'll come back to merge and then prep a new release.

@mgorny

mgorny commented Jul 30, 2026

Copy link
Copy Markdown
Contributor Author

I'd like to ask for your opinion, based on your experience: the sdist contains a file named PKG-INFO, which shows up in the git status output. Should this file be added to .gitignore?

I don't think so. .gitignore only covers what's actually in the working directory of the git repository, and I don't think there's really any scenario when that file gets created in that working directory.

@kurtmckee
kurtmckee merged commit 07d5d5e into python-syndication:main Jul 30, 2026
4 checks passed
@mgorny
mgorny deleted the sdist branch July 30, 2026 18:59
@mgorny

mgorny commented Jul 30, 2026

Copy link
Copy Markdown
Contributor Author

Thanks!

@kurtmckee

Copy link
Copy Markdown
Member

You're welcome, and thank you for contributing! ❤️

I just released v2.0.1. Let me know if you encounter any additional issues!

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.

Tests missing from source distribution

2 participants