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

Exclude CODE_OF_CONDUCT.md, AUTHORSHIP.md and pygmt/tests directory from distributions #2957

Merged
merged 1 commit into from Jan 6, 2024

Conversation

seisman
Copy link
Member

@seisman seisman commented Jan 6, 2024

Changes in this PR:

With this PR, the new tarball is 176 KB, with following files:

.
├── AUTHORS.md
├── CITATION.cff
├── LICENSE.txt
├── MANIFEST.in
├── PKG-INFO
├── README.rst
├── pygmt
│   ├── __init__.py
│   ├── accessors.py
│   ├── clib
│   │   ├── __init__.py
│   │   ├── conversion.py
│   │   ├── loading.py
│   │   └── session.py
│   ├── datasets
│   │   ├── __init__.py
│   │   ├── earth_age.py
│   │   ├── earth_free_air_anomaly.py
│   │   ├── earth_geoid.py
│   │   ├── earth_magnetic_anomaly.py
│   │   ├── earth_mask.py
│   │   ├── earth_relief.py
│   │   ├── earth_vertical_gravity_gradient.py
│   │   ├── load_remote_dataset.py
│   │   ├── samples.py
│   │   └── tile_map.py
│   ├── exceptions.py
│   ├── figure.py
│   ├── helpers
│   │   ├── __init__.py
│   │   ├── caching.py
│   │   ├── decorators.py
│   │   ├── tempfile.py
│   │   ├── testing.py
│   │   ├── utils.py
│   │   └── validators.py
│   ├── io.py
│   ├── session_management.py
│   ├── sphinx_gallery.py
│   └── src
│       ├── __init__.py
│       ├── basemap.py
│       ├── binstats.py
│       ├── blockm.py
│       ├── coast.py
│       ├── colorbar.py
│       ├── config.py
│       ├── contour.py
│       ├── dimfilter.py
│       ├── filter1d.py
│       ├── grd2cpt.py
│       ├── grd2xyz.py
│       ├── grdclip.py
│       ├── grdcontour.py
│       ├── grdcut.py
│       ├── grdfill.py
│       ├── grdfilter.py
│       ├── grdgradient.py
│       ├── grdhisteq.py
│       ├── grdimage.py
│       ├── grdinfo.py
│       ├── grdlandmask.py
│       ├── grdproject.py
│       ├── grdsample.py
│       ├── grdtrack.py
│       ├── grdview.py
│       ├── grdvolume.py
│       ├── histogram.py
│       ├── image.py
│       ├── info.py
│       ├── inset.py
│       ├── legend.py
│       ├── logo.py
│       ├── makecpt.py
│       ├── meca.py
│       ├── nearneighbor.py
│       ├── plot.py
│       ├── plot3d.py
│       ├── project.py
│       ├── rose.py
│       ├── select.py
│       ├── shift_origin.py
│       ├── solar.py
│       ├── sph2grd.py
│       ├── sphdistance.py
│       ├── sphinterpolate.py
│       ├── subplot.py
│       ├── surface.py
│       ├── ternary.py
│       ├── text.py
│       ├── tilemap.py
│       ├── timestamp.py
│       ├── triangulate.py
│       ├── velo.py
│       ├── which.py
│       ├── wiggle.py
│       ├── x2sys_cross.py
│       ├── x2sys_init.py
│       └── xyz2grd.py
├── pygmt.egg-info
│   ├── PKG-INFO
│   ├── SOURCES.txt
│   ├── dependency_links.txt
│   ├── requires.txt
│   └── top_level.txt
├── pyproject.toml
└── setup.cfg

7 directories, 102 files

Fixes #2956.

@@ -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"}
Copy link
Member Author

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.)

@seisman seisman added the maintenance Boring but important stuff for the core devs label Jan 6, 2024
@seisman seisman added this to the 0.11.0 milestone Jan 6, 2024
@@ -56,15 +55,12 @@ changelog = "https://www.pygmt.org/latest/changes.html"

[tool.setuptools]
platforms = ["Any"]
include-package-data = true
license-files = ["LICENSE.txt"]
Copy link
Member

@weiji14 weiji14 Jan 6, 2024

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?

Copy link
Member Author

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).

Copy link
Member

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.

pyproject.toml Show resolved Hide resolved
@seisman seisman merged commit 5696542 into main Jan 6, 2024
17 checks passed
@seisman seisman deleted the manifest branch January 6, 2024 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Exclude test files from source/binary distributions
2 participants