search

Caltech-IPAC / hiresprv

Keck HIRES PRV pipeline service access
4 stars 0 forks source link

Add description and license to setup.py #8

Open stargaser opened 5 years ago

stargaser commented 5 years ago

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 commented 5 years ago

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

bjfultn commented 4 years ago

Let's revisit this comment from Dave.