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 title and fix short identifier #38

Merged
merged 2 commits into from
Jul 31, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
ISC License

Copyright (c) 2016, Joshua Bronson <jab@math.brown.edu>

Permission to use, copy, modify, and/or distribute this software for any
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,14 @@
long_description=long_description,
keywords='dict, dictionary, mapping, bidirectional, bijection, bijective, injective, two-way, 2-way, double, inverse, reverse',
url='https://github.com/jab/bidict',
license='ISCL',
license='ISC',
Copy link
Owner

Choose a reason for hiding this comment

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

Looking through the first page of results for https://github.com/search?utf8=%E2%9C%93&q=filename%3Asetup.py+license+iscl&type=Code&ref=searchresults I see plenty of license='ISCL' as well as license='ISC' andlicense='ISC License (ISCL)'. Can you provide a reference for why your proposed change is right and the others are wrong? Another quick search I just did for "setup.py license values" turned up http://the-hitchhikers-guide-to-packaging.readthedocs.io/en/latest/creation.html which actually advises that license should be set to the filename containing the license, which is news to me.

Copy link
Contributor Author

@waldyrious waldyrious Jul 31, 2016

Choose a reason for hiding this comment

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

I am only vaguely familiar with publishing packages on PyPI, so I can't comment on what value the license field should have on setup.py.

It is true that "ISCL" is prevalent, and I intend to work to reduce that. Right now, I am on a mission to add the ISC license title to the license files, though, so that step will have to wait a bit :)

As for justification: as I mentioned in the other comment, the correct short identifier for the ISC license is simply "ISC". Given that most of the licenses that include an acronym do so because their full name doesn't include it, and many don't include an acronym at all, I supposed it would make sense to omit the redundant "(ISC)". That said, I have no strong objections to keeping it, if you prefer that -- but if so, the acronym should be "ISC", not "ISCL".

I realize this is not coherent with others like GPL, AFL, etc, but the license identifiers have worse incongruences than that :) In fact, if we were to insist on ISCL, then we should also advocate for MITL, BSDL, etc, which I don't believe would be practical.

packages=['bidict'],
package_data=dict(bidict=['VERSION']),
zip_safe=True,
classifiers=[
'Development Status :: 4 - Beta',
'Intended Audience :: Developers',
'License :: OSI Approved :: ISC License (ISCL)',
'License :: OSI Approved :: ISC License',
Copy link
Owner

@jab jab Jul 31, 2016

Choose a reason for hiding this comment

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

https://pypi.python.org/pypi?%3Aaction=list_classifiers lists the classifier as I had it, with (ISCL) at the end, which is where I got this from. Can you provide a reference explaining why that's wrong and this is right?

Copy link
Contributor Author

@waldyrious waldyrious Jul 31, 2016

Choose a reason for hiding this comment

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

Sure. The second commit has the to the relevant authoritative sources in the extended description:

see https://opensource.org/licenses/ISC and http://spdx.org/licenses/ISC.html

Sorry that I didn't make this clearer in the PR's main description text. I'll add it now, for future reference.

By the way, I did submit a PR to fix the acronym in the list of classifiers (https://github.com/russianidiot/classifiers.py/pull/1) [2020-06-20 update: I now submitted it to the proper repo: https://github.com/pypa/trove-classifiers/pull/35]. I'm not entirely sure that is the correct procedure to go about fixing this, but if it isn't, I expect that PR to at least open the conversation to reach that goal.

'Natural Language :: English',
'Operating System :: OS Independent',
'Programming Language :: Python :: 2.7',
Expand Down