-
Notifications
You must be signed in to change notification settings - Fork 220
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
Exclude CODE_OF_CONDUCT.md, AUTHORSHIP.md and pygmt/tests directory from distributions #2957
Conversation
…rom distributions
@@ -7,7 +7,6 @@ name = "pygmt" | |||
description = "A Python interface for the Generic Mapping Tools" | |||
readme = "README.rst" | |||
requires-python = ">=3.9" | |||
license = {text = "BSD License"} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#license
If you are using a standard, well-known license, it is not necessary to use this field. Instead, you should one of the classifiers starting with License ::. (As a general rule, it is a good idea to use a standard, well-known license, both to avoid confusion and because some organizations avoid software whose license is unapproved.)
@@ -56,15 +55,12 @@ changelog = "https://www.pygmt.org/latest/changes.html" | |||
|
|||
[tool.setuptools] | |||
platforms = ["Any"] | |||
include-package-data = true | |||
license-files = ["LICENSE.txt"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing the include-package-data = true
line is the same as keeping it, since that's the default according to https://setuptools.pypa.io/en/latest/userguide/datafiles.html#include-package-data (when using setuptools>61.0.0 with pyproject.toml). Maybe just keep the line?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't have package data to include, so keeping this line may be more confusing (although the default is still true
).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mm ok, I see you removed the [tool.setuptools.package-data]
section, so should be ok to remove it.
Changes in this PR:
CODE_OF_CONDUCT.md
license-files
to correctly excludeAUTHORSHIP.md
(see Exclude test files from source/binary distributions #2956 (comment))pygmt/tests
directoryWith this PR, the new tarball is 176 KB, with following files:
Fixes #2956.