Skip to content

Add LICENSE and tests using flit#44

Closed
apraga wants to merge 1 commit intosphinx-doc:mainfrom
apraga:main
Closed

Add LICENSE and tests using flit#44
apraga wants to merge 1 commit intosphinx-doc:mainfrom
apraga:main

Conversation

@apraga
Copy link
Copy Markdown

@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
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/wpilibsuite/sphinxext-opengraph",
license="LICENSE.md",
Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
Collaborator

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
Copy Markdown
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
Copy Markdown
Collaborator

Daltz333 commented Aug 1, 2021

Can you not package it directly from the source code?

@apraga
Copy link
Copy Markdown
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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 2, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants