Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release publishing workflow issues #43

Open
knthm opened this issue Apr 27, 2022 · 1 comment
Open

Release publishing workflow issues #43

knthm opened this issue Apr 27, 2022 · 1 comment
Labels
Discussion help wanted Extra attention is needed

Comments

@knthm
Copy link

knthm commented Apr 27, 2022

I'm trying to package this python module for a Linux distro and there are some issues I've noticed with your published packages:

  1. Source releases don't include a copy of the MIT license
    the MIT license requires you provide a copy of the LICENSE file when you distribute your module
  2. Some releases published on PyPI aren't published on GitHub
    retrieving the source releases for packaging from GitHub brings lower maintenance overhead and better transparency than retrieving them from PyPI
  3. Release file naming isn't very packager friendly
    the module is named notify-py, yet the published release file names are notify_py, inconsistencies like this increase the verbosity of the packaging definitions and maintenance overhead
@knthm knthm changed the title Synchronize PyPI and GitHub releases Various issues with published releases Apr 27, 2022
@knthm knthm changed the title Various issues with published releases Release publishing workflow issues Apr 27, 2022
@ms7m
Copy link
Owner

ms7m commented May 22, 2022

Hey @KloudJack, sorry for the late response!

Source releases don't include a copy of the MIT license
the MIT license requires you provide a copy of the LICENSE file when you distribute your module

Agreed, I'll get this in the next release.

Some releases published on PyPI aren't published on GitHub
retrieving the source releases for packaging from GitHub brings lower maintenance overhead and better transparency than retrieving them from PyPI

I agree, I'll update the CI workflow to also do a Github release.

Release file naming isn't very packager friendly
the module is named notify-py, yet the published release file names are notify_py, inconsistencies like this increase the verbosity of the packaging definitions and maintenance overhead

Unfortunately, i did initially tend the package to be installable over "notify_py" but pip automatically changes any underscores to dashes. If there is an alternative solution that makes it easier for you guys to package it up, I'm happy to help.

@ms7m ms7m added help wanted Extra attention is needed Discussion labels Nov 28, 2022
@ms7m ms7m pinned this issue Nov 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discussion help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants