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 description and license to setup.py #8

Open
stargaser opened this issue Sep 24, 2018 · 2 comments
Open

Add description and license to setup.py #8

stargaser opened this issue Sep 24, 2018 · 2 comments
Assignees

Comments

@stargaser
Copy link
Contributor

I suggest to add a few more lines to setup.py, inside the setup() part. I am not sure about the wording so I am not attempting a pull request.

description="Interface to processing service for Keck HIRES precision radial velocities",

Even more optional, but also nice for PyPI.org, is to point to the README.md or perhaps one of the .rst files, as appropriate, for the long description. See e.g. https://packaging.python.org/guides/making-a-pypi-friendly-readme/

I recommend to add license information. Here are examples I got from Astropy, assuming this will be a BSD license.

license='BSD',

and inside the classifiers:

'License :: OSI Approved :: BSD License',

I think you can also add the filename of the license file like this:

license_file = 'LICENSE.txt'
@bjfultn
Copy link
Collaborator

bjfultn commented Sep 26, 2018

We need to wait for certain issues to be sorted out before we can request a license from Caltech.

bjfultn pushed a commit that referenced this issue Sep 4, 2019
@bjfultn
Copy link
Collaborator

bjfultn commented Oct 4, 2019

Let's revisit this comment from Dave.

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

No branches or pull requests

3 participants