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.

Sign up for GitHub

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

avoid pypi namespace clash #2544

Closed
wants to merge 2 commits into from
Closed

avoid pypi namespace clash #2544

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8155278
avoid pypi namespace clash
marqh May 10, 2017
9e07587
enhanced PKG-INFO
marqh May 24, 2017
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
10 changes: 8 additions & 2 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,11 +194,17 @@ def extract_version():


setup(
name='Iris',
name='iris-scitools',
Copy link
Member

Choose a reason for hiding this comment

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

Is this value only used by setuptools? If not I could see it causing unusual side-effects...

Copy link
Member Author

Choose a reason for hiding this comment

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

it is my understanding that this is only used in setuptools/distutils

I would be greatly appreciative of supporting information for this assertion, i would like to minimise unwanted consequences

Copy link
Member

@DPeterK DPeterK May 11, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

@marqh the best I can come up with after quite a lot of looking is the first parargraph in this section, which is still far from definitive...

Copy link
Member

@bjlittle bjlittle May 24, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

@marqh @dkillick @pp-mo or is it scitools-iris ? That makes more sense to me ... organisation then module, rather than the other way around.

@marqh Have you tested doing a python setup.py build and python setup.py install etc just to make sure that nothing odd is happening?

Copy link
Member Author

Choose a reason for hiding this comment

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

@bjlittle

this 'name' appears in the folder structure of the installation via setuptools, e.g.:

>>> import iris; iris
<module 'iris' from '/home/h04/itmh/.local/lib/python2.7/site-packages/iris_scitools-1.12.0.dev0-py2.7.egg/iris/__init__.pyc'>

and in the PKG-INFO

Metadata-Version: 1.0
Name: iris-scitools
Version: 1.12.0.dev0
Summary: Data interoperability library
Home-page: http://scitools.org.uk/iris/
Author: UK Met Office
Author-email: https://groups.google.com/forum/#!forum/scitools-iris
License: LGPLv3
Description: Data interoperability library for meteorological and 
        oceanographic data formats, providing 
        data analysis and visualisation capabilities
        
Platform: any

Copy link
Member

Choose a reason for hiding this comment

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

I think I prefer iris-scitools. If I was searching for this, I would feel more like I had found what I was looking for this way round than the other way around.

Copy link
Member

Choose a reason for hiding this comment

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

My vote is for scitools-iris, because that's how we always refer to Iris if we need to make it clear it's the SciTools package called Iris, such as we need to here. We've even used this name for Iris elsewhere in this PR...

Copy link
Contributor

Choose a reason for hiding this comment

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

If there's no practical reason to prefer one or the other, I prefer scitools-iris.

Copy link
Member Author

Choose a reason for hiding this comment

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

there appears to be something of a L:R split here

I think that the practical aspect of iris appearing at the start of the string should carry the day, e.g.

If the packages were sorted alphabetically, and someone looked for iris they'd find iris-scitools nearby.

Although scitools-iris might feel more natural to some developers, I think for the 'i want to find a package' use case which pypi addresses, iris-scitools appears more practical to me

Copy link
Member

Choose a reason for hiding this comment

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

I'd go for scitools-iris as per PEP0423 (note: PEP status=deferred, but it does give some compelling evidence)

version=extract_version(),
url='http://scitools.org.uk/iris/',
author='UK Met Office',

license='LGPLv3',
platforms='any',
description='Data interoperability library',
long_description=('Data interoperability library for meteorological and \n'
'oceanographic data formats, providing \n'
'data analysis and visualisation capabilities.'),
author_email='https://groups.google.com/forum/#!forum/scitools-iris',
packages=find_package_tree('lib/iris', 'iris'),
package_dir={'': 'lib'},
package_data={
Expand Down