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

Update PyCDR packaging strategy #4

Merged
merged 2 commits into from
May 28, 2021

Conversation

thijsmie
Copy link
Contributor

PyCDR does not need any complicated setup so this PR updates it to use the newer setup.cfg method. setup.py is still present as empty shell to allow older (v18 and below) pip distributions to still use the installer.

Copy link
Contributor

@eboasson eboasson left a comment

Choose a reason for hiding this comment

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

LGTM, but I don't have any detailed knowledge about Python packaging, so this is just a common sense thing.

Bug Tracker = https://github.com/eclipse-cyclone/cyclonedds-python/issues
classifiers =
Development Status :: 4 - Beta
License :: OSI Approved :: Eclipse Public License 2.0 (EPL-2.0)
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't EDLv1 be mentioned as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It really should, but it is not in the officially supported classifier list. I am looking into how to get it on there.

Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if you cannot just use BSD-3-Clause instead? It's the same license and that's what we mention in the headers(?)

Copy link
Contributor

Choose a reason for hiding this comment

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

SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause that's what's in the top of our headers...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The full list is here, BSD-3 is also not on there. I am wondering, since these classifiers are just strings, if I can just add new ones. I will run a test on the test-pypi website.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I found instructions in the Pypi FAQ and filed an issue here for it to be added.

Copy link
Contributor

Choose a reason for hiding this comment

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

The Eclipse Distribution License is an OSI Approved Open Source License by means of the New BSD License ([as stated on the Eclipse Foundation website](The Eclipse Distribution License is an OSI Approved Open Source License by means of the New BSD License)). You can probably just go with "BSD"(?) as the OSI identifies "BSD-3-Clause" and "BSD-2-Clause". Perhaps BSD covers both(?). Seems more people have this problem: PEP 639. I'd just use BSD 3-Clause "New" or "Revised" License (BSD-3-Clause)

@thijsmie
Copy link
Contributor Author

LGTM, but I don't have any detailed knowledge about Python packaging, so this is just a common sense thing.

The general consensus is to move away from running code as part of the installation process, which is why we get binary wheels for more complex packages and this setup.cfg stuff for simple python-only packages.

@eboasson
Copy link
Contributor

@thijsmie any idea how long it will take for the BSD 3-Clause license to get added to the classifier list? If it is going to take much longer, perhaps there's another way to indicate this possibility in a free-form note somewhere and simply have the main license be EPL2.

@thijsmie
Copy link
Contributor Author

No activity from Pypi maintainers on the issue so far, not even "you can submit a pull request with this change". Shall I just add the "BSD" classifier with a comment that BSD-Clause-3 is intended?

@eboasson
Copy link
Contributor

No activity from Pypi maintainers on the issue so far, not even "you can submit a pull request with this change".

Bummer ... so

Shall I just add the "BSD" classifier with a comment that BSD-Clause-3 is intended?

Let's do that.

@eboasson eboasson merged commit 0059f40 into eclipse-cyclonedds:master May 28, 2021
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.

3 participants