search

rossant / ipycache

Defines a %%cache cell magic in the IPython notebook to cache results of long-lasting computations in a persistent pickle file
BSD 3-Clause "New" or "Revised" License
139 stars 35 forks source link

Update license copyright line, wording, and file extension #68

Closed mbrukman closed 2 years ago

mbrukman commented 2 years ago

The current version of LICENSE.md has a few issues:

  1. the copyright is listed as "Copyright (c) 2013, Cyrille Rossant" but there have been other contributors since then besides Cyrille

    Solution options: (a) we can switch this to "Copyright (c) 2013 Cyrille Rossant and contributors" or (b) as some projects do this "Copyright (c) 2013 ipycache authors" with a relevant AUTHORS.txt and CONTRIBUTORS.txt in the repo to clarify. @rossant – I'm fine with (a) if you'd like to keep your name in the copyright line as the original author and primary contributor.

  2. There's strange wording in the license:

    https://github.com/rossant/ipycache/blob/4042ed1372260a4e02cd6eddcf814918405259c1/LICENSE.md#L16-L18

    This looks like the license text was copied from another project or company where the name "border" was relevant, but the actual BSD-3-Clause license from OSI says:

    Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

    Solution: I would like to change this to match the original wording since this is not relevant.

  3. the file extension is .md but it's really a text file and written as such, so it should be switched to a plain-text file

    Solution is easy: switch the file to .txt extension

@rossant — what are your thoughts on (1)? Would you prefer option (a) or (b)? I think items (2) and (3) are non-controversial; please let me know if there's some history I should be aware of for (2) and if you have any concerns about the proposed changes.

Thanks!

rossant commented 2 years ago

Looks good to me! For the license, there might be a third option, something like this (IPython):


- Copyright (c) 2022-Present, ipycache development team
- Copyright (c) 2013-2022, Cyrille Rossant

what do you think?

mbrukman commented 2 years ago

@rossant — I looked at git history via git log --pretty="format:%an %ad", and found that the first commit by someone other than you was from 2013, not 2022, so I am going with your suggestion, but with s/2013/2022/, hope that's OK. Sending PR shortly.