Automate publishing Python package on PyPI

[bittner]

Adds two Tox environments that help with publishing the Python package on PyPI.

• tox -e package can be used for linting to help detect packaging issues.
• tox -e package -- upload allows to publish the package on PyPI.
• tox -e ensure_version_matches $GIT_TAG verifies that the package version matches the semantic Git tag on the current commit. This is used by the GHA configuration to prevent a mismatch of tags and the version of the published package.

To make publishing work, you need to add the 2 secrets PYPI_USERNAME and PYPI_PASSWORD to Settings ➜ Secrets ➜ Actions with the PyPI access token for the project, as described in the Python packaging user guide.

Related

• Publish all releases on PyPI #1579
• Is setup.py deprecated? – The use as a command line tool is deprecated

[lengau]

Thanks for this!

I think snapcraft 8 lets us get rid of the setup.py file, but we'll find out when I run the CI

[bittner]

I think snapcraft 8 lets us get rid of the setup.py file, but we'll find out when I run the CI

The snap-build job fails, because the charmcraft snap configuration takes for granted that setup.py is around:

:: ++ python3 setup.py --version
:: python3: can't open file '/root/parts/charmcraft/src/setup.py': [Errno 2] No such file or directory

From a Python (packaging) point of view the use of setup.py is legacy and every modern Python package should switch over to using (just) pyproject.toml. I guess it's okay if I try to fix the snap configuration with an additional commit to make the pipeline pass.

[bittner]

The snap-build job fails as it can't find the craft_cli module.

ModuleNotFoundError: No module named 'craft_cli'

I can't see that the craft-cli Python package is installed in the job, I can only see it as a dependency in requirements.txt.

Can anyone see what is the problem?

[bittner]

Can anyone see what is the problem?

Okay, looks like there is a problem with the sed command before that:

sed: -e expression #1, char 14: unterminated `s' command

The problem is that that with the new setup the returned version string also contains the package name. I'll try to find a solution. Suggestions welcome!

EDIT: Stupid me! A closing / was missing. 🤪

[bittner]

The CI jobs all pass now (on my personal fork). I rebased the branch, and I made separate commits to document the specific changes that were necessary to work around a few build issues. 📜

Hope that looks good enough now for the PR to be merged. 🤞

[bittner]

I have signed the CLA now. I use a different email address on Launchpad than on GitHub, that's why the check probably didn't find my Launchpad account.

[bittner]

The cla-check still fails. I checked my Launchpad account again; looks like there was another account with the email address I use on GitHub. I merged the accounts on Launchpad now.

[bittner]

I received an email notification this morning saying, I was added as a member of Canonical Contributor Agreement.

I assume, the cla-check job would now succeed.

[bittner]

@lengau Let me know what needs to be changed, if anything, so that I can help getting this merged. Thank you! 👍

[bittner]

I rebased the branch of this PR again to keep it up-to-date with the main branch.

If the changes look okay, I'd be happy to see this merged. Otherwise, please let me know what needs to be changed.

[bittner]

Is there a reason why this PR isn't considered for merging? Any arguments against the changes? Anything that needs to be updated?

It would be very helpful if the recent release(s) of charmcraft were published also on PyPI. For example, I'm currently blocked by the No keyring found error that was fixed in version 2.3.0 by allowing anonymous downloads of charm library modules. As explained in #1579 (comment) a pure-Python installation is needed for the CI use case.

[lengau]

Please re-add setup.py, and then I'm happy with this :-)

I've created #1635 for seeing if we can remove setup.py at a later date so we don't block this PR with it

[bittner]

ping 🔔

@lengau Alex, I think this PR is now ready for merging. Can you (or some other maintainer) take a look?

[mattculler]

👍

[bittner]

Thanks for merging! 💯

Now don't forget to add the secrets to the project settings to make automatic publishing succeed! 🤖