search

wpilibsuite / sphinxext-opengraph

Sphinx extension to generate unique OpenGraph metadata
https://sphinxext-opengraph.readthedocs.io
Other
74 stars 27 forks source link

Add LICENSE and tests using flit #44

Open apraga opened 3 years ago

apraga commented 3 years ago

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,

TheTripleV commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

Can you not package it directly from the source code?

apraga commented 3 years ago

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.