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

PR: Update setup.py description, metadata, links, and more #7582

Merged
merged 9 commits into from Jul 30, 2018

Conversation

CAM-Gerlach
Copy link
Member

Pull Request Checklist

  • Read and followed this repo's Contributing Guidelines
  • Based your PR on the latest version of the correct branch (master or 3.x)
  • Followed PEP8 for code style
  • Ensured your pull request hasn't eliminated unrelated blank lines/spaces,
    modified the spyder/defaults directory, or added new icons/assets
  • Described your changes and the motivation for them below
  • Noted what issue(s) this pull request resolves, creating one if needed

Description of Changes

Updates and expands our description, metadata and links in setup.py to make our page more compelling, easy to find, conformant and informative on PyPI (and anything else that uses the same). In particular:

  • Updates our package short/long description and docstring to give more substantive, well-written detail about Spyder and use the proper capitalization, and harmonize it with that in our other resources
  • Updates our homepage URL to point to our actual website homepage
  • Fixes the currently broken download URL to point to our comprehensive download page
  • Adds additional Trove classifiers and keywords to make Spyder more visible, easier to find and more specific
  • Adds more specific platforms for clarity (as it will only currently run on PyQt5 supported platforms)
  • Adds an author email (currently @ccordoba12 's public one) to follow best practices and match peers

Hopefully this can be merged in time for 3.3.1 to greatly improve our PyPI presentation (and anything else that pulls the same data), and also since as discussed in winpython/winpython#654 WinPython will be shortly using this information to populate its own packages listings various places so we don't want it to be out of date.

Part of the broader effort coordinated in spyder-ide/spyder-docs#39

Issue(s) Resolved

Fixes #7581

@pep8speaks
Copy link

pep8speaks commented Jul 30, 2018

Hello @CAM-Gerlach! Thanks for updating the PR.

  • In the file setup.py, following are the PEP8 issues :

Line 56:1: E402 module level import not at top of file
Line 56:50: E262 inline comment should start with '# '
Line 160:1: E122 continuation line missing indentation or outdented

Comment last updated on July 30, 2018 at 21:38 Hours UTC

setup.py Outdated
scientific packages, including NumPy, SciPy, Pandas, IPython, QtConsole,
Matplotlib, SymPy, and more.
Beyond its many built-in features, Spyder's abilities can be extended even
further via its plugin system and API.
Copy link
Member

Choose a reason for hiding this comment

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

This

Beyond its many built-in features, Spyder's abilities can be extended even
further via its plugin system and API.

is not quite true in Spyder 3. It'll be in Spyder 4, but not right now, so please remove it

Copy link
Member Author

Choose a reason for hiding this comment

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

Removed and API and changed to via third-party plugins. to imply the "system" isn't quite so developed at the moment.

Do note that the verbatim phrase you cited currently appears in our website main page, Docs main page, Readme introduction, OpenCollective About section, (IIRC) that brochure I helped you with, various documents/proposals we've produced, etc. and others I don't remember at the moment since its part of our standard 4/5-line blurb that we use everywhere.

setup.py Outdated
"""),
download_url=__website_url__ + "#fh5co-download",
author="The Spyder Project Contributors",
author_email="ccordoba12@gmail.com",
Copy link
Member

Choose a reason for hiding this comment

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

Please remove this. I don't want people to write me personal emails about Spyder.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, good point. Removed as requested.

Copy link
Member

@goanpeca goanpeca Jul 30, 2018

Choose a reason for hiding this comment

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

we could use

admin@spyder-ide.org ? I can set forwarding to your account @ccordoba12 ?

or info@spyder-ide.org (which will arrive to admin anyway (with a label))

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 does seem most other big projects do have something there. Another alternative if you think we'll get a lot of people asking for help is our Google Group email spyderlib@googlegroups.com

If we get a high percentage of help, development, etc queries through that email it would direct them to a better place where they can be resolved publicly; on the other hand there is a chance people might send private inquiries to it (although being a Google Groups email it should be obvious that its public, and people who really care about confidentiality can easily just look you up on Github since your email is published right on your page).

There's also the fact that they would have to join the group before being able to email to it, but we could try @goanpeca 's solution to start and if you get a substantial amount of emails that could just go on the Group instead, we redirect it to the Google Groups email going forward.

Copy link
Member

Choose a reason for hiding this comment

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

admin@spyder-ide.org ? I can set forwarding to your account @ccordoba12 ?

But that's my point: people should understand that the best way to reach us is to open an issue on Github or start a conversation on Google Groups, not to write an email.

Copy link
Member

Choose a reason for hiding this comment

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

Another alternative if you think we'll get a lot of people asking for help is our Google Group email spyderlib@googlegroups.com

I agree with this one. @CAM-Gerlach, please use it.

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree with this one. @CAM-Gerlach, please use it.

Done as requested.

@CAM-Gerlach
Copy link
Member Author

@ccordoba12 Thanks, changed as requested.

@CAM-Gerlach
Copy link
Member Author

Segfault on CircleCI; seems unrelated. However to my unending annoyance I can't re-run builds on CircleCI due to how the permissions are set. Is there any way you can fix the permissions to allow triggering a re-run of a failed build with normal member-level access (i.e. not direct write access) like on every other CI?

@CAM-Gerlach
Copy link
Member Author

CAM-Gerlach commented Jul 30, 2018

@ccordoba12 Added back author email, with Google Groups as requested.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants