berinhard/pyp5js

Add GPL3 header to every single file in the project

berinhard opened this issue · 3 comments

It's being common to have people vendoring pyp5js and this is not a problem. But, currently, the source code doesn't make it an easy thing to do and still be license compliant.

To avoid that, I want to add GPL3 header to every file present in the project and/or generate by the compiler process.

Something similar to this script should also be added to the CI process to enforce the license header.

Also, the README must be updated to states more clearly about vendoring and licensing.

  • GPL3 Header in every file;
  • Header check in CI;
  • Update in the readme;
jvfe commented

Hi!

I believe this to be very important and I think I could easily tackle the first two check marks in a PR (I believe the statement in the README should be written by you, though). But I just had a question, the headers to add in this case should be the LGPL3 header and not the GPL3 header you linked above, right? Since the project is licensed under LGPL-3, not GPL-3.

If that's the case, the actual header should be something like this, right?

pyp5js
Copyright (C) 2019-2021 The pyp5js Contributors 

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Thanks @jvfe! You're correct about using LGPL3. I'll update the task title. About the CI integration, we can base ourselves on pypi's license check. They have this script that we could adapt to our needs and add it to the .github/workflows/ci.yml.

Feel free to tackle this one and open a PR.

Fixed by #200