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

Add LICENSE and tests using flit #44

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add LICENSE and tests using flit #44

wants to merge 1 commit into from

Conversation

apraga
Copy link

@apraga apraga commented Jul 29, 2021

Hi,

Currently, the package on pypi does not have a LICENSE nor tests. As I'm creating a port for FreeBSD, those would be very valuable. I've taken the liberty to use flit to correct that.

Thanks,

@apraga apraga changed the title Add LICENSE and tests using filt Add LICENSE and tests using flit Jul 29, 2021
@@ -28,6 +28,7 @@
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/wpilibsuite/sphinxext-opengraph",
license="LICENSE.md",
Copy link
Contributor

Choose a reason for hiding this comment

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

Isn't this inconsistent with renaming from LICENSE.md to LICENSE

Copy link
Author

Choose a reason for hiding this comment

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

Indeed, it's a leftover from an earlier version (it's the first time I have to create a python package)

@TheTripleV
Copy link
Member

Thanks for the PR and intention to package this project for FreeBSD! Not including the license is an omission and should be included. However, I don't think that tests should be included. Our testing only dependencies shouldn't be required to use the project. Additionally, hardcoding the version isn't a good idea for us as we could forget to change it. If we do want to include the version, it would probably have to be generated, either in setup.py or in the CI.

@apraga
Copy link
Author

apraga commented Aug 1, 2021

Hi,
The hardcoded version number is required by flit but flit is only a suggestion for packaging. I could do another PR if you tell me how to add the missing files to your current workflow.
Tests would be super helpful to create a FreeBSD package from a security and quality point of view (by testing on different architectures, python version...).
Thanks,

@Daltz333
Copy link
Member

Daltz333 commented Aug 1, 2021

Can you not package it directly from the source code?

@apraga
Copy link
Author

apraga commented Aug 1, 2021

It is possible, and that's what I did as a temporary workaround. However, using standard Python ecostystem (PyPi) is the method of choice, unless there is a compelling reason not to.

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.

None yet

4 participants