From 63cfeadbf1588226942b3f28045f74e1fe51ce35 Mon Sep 17 00:00:00 2001 From: Patrick Peglar Date: Fri, 25 Apr 2025 16:42:56 +0100 Subject: [PATCH] Realign with re-styled template. --- MANIFEST.in | 91 ++++++++++++++++++++++++----------------------------- 1 file changed, 41 insertions(+), 50 deletions(-) diff --git a/MANIFEST.in b/MANIFEST.in index f6c51252c8..31abc34839 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -9,17 +9,16 @@ # SECTION: main code sources # N.B. package dir is "lib" not "src" recursive-include lib *.cdl *.cml *.json *.md *.py *.template *.txt *.xml -#--- -# principles: -# - *no* "prune" command is used -# - use "include-recursive", by relevant file extensions -# hints: -# - top-level dir is typically "src", but maybe "lib" or -# - default package rules mean we generally don't actually *need* a statement -# - but it's better to be explicit -# - extension filetypes are typically sources (*.py) -# - might also need testdata files, e.g. *.nc, *.npy *.npz -# - also possibly non-python, e.g. *.pyx for Cython + # principles: + # - *no* "prune" command is used + # - use "include-recursive", by relevant file extensions + # hints: + # - top-level dir is typically "src", but maybe "lib" or + # - default package rules mean we generally don't actually *need* a statement + # - but it's better to be explicit + # - extension filetypes are typically sources (*.py) + # - might also need testdata files, e.g. *.nc, *.npy *.npz + # - also possibly non-python, e.g. *.pyx for Cython #--------- @@ -27,61 +26,54 @@ recursive-include lib *.cdl *.cml *.json *.md *.py *.template *.txt *.xml prune docs # and if required ... include ONLY docs source files. # E.G. recursive-include docs *.rst *.inc -#--- -# principles: -# - use prune to ignore everything (optionally: except the docs sources) -# hints: -# - most projects don't want to package the docs, but some currently do (cf-units). + # principles: + # - use prune to ignore everything (optionally: except the docs sources) + # hints: + # - most projects don't want to package the docs, but some currently do (cf-units). #--------- # SECTION: requirements prune requirements recursive-include requirements *.txt -#--- -# principles: -# include just requirements-level info, not lock files -# hints: -# - not all projects include requirements, but they can be drawn in anyway by dynamic dependencies -# in the setuptools build process, linked via config in pyproject.toml -# - for some repos, the *.txt are actually lockfiles. This probably needs fixing. + # principles: + # include just requirements-level info, not lock files + # hints: + # - not all projects include requirements, but they can be drawn in anyway by dynamic dependencies + # in the setuptools build process, linked via config in pyproject.toml + # - for some repos, the *.txt are actually lockfiles. This probably needs fixing. #--------- # SECTION: root files exclude .flake8 exclude .git-blame-ignore-revs +exclude .git_archival.txt +exclude .gitattributes exclude .gitignore +exclude .lycheeignore exclude .mailmap exclude .pre-commit-config.yaml exclude .readthedocs.yml exclude .ruff.toml exclude CHANGES include CITATION.cff -exclude codecov.yml exclude CODE_OF_CONDUCT.md include COPYING include COPYING.LESSER include LICENSE exclude Makefile +exclude codecov.yml include noxfile.py -#--- -#Iris-specific additions -exclude .git_archival.txt -exclude .gitattributes -exclude .lycheeignore - - -#--- -# principles: -# - *ANY* file in the root should be explicitly "include"- or "exclude"-d -# - EXCEPT (possibly) those covered by setuptools default rules (see above link) -# - including : README.md/.rst; pyproject.toml; setup.py/.cfg -# - N.B. a GHA "ci-manifest" check, if used, will check all this -# - the above are typical ones : given in sorted order -# - NB many will (eventually) be templated, but that is a separate issue -# - probably, this section can be included as *boilerplate* -# - i.e. it doesn't matter if some of the files mentioned don't exist + # principles: + # - *ANY* file in the root should be explicitly "include"- or "exclude"-d + # - EXCEPT (possibly) those covered by setuptools default rules (see above link) + # - including : README.md/.rst; pyproject.toml; setup.py/.cfg + # - N.B. a GHA "ci-manifest" check, if used, will check all this + # - the above are typical ones : given in sorted order + # - NB many will (eventually) be templated, but that is a separate issue + # - probably, this section can be included as *boilerplate* + # - i.e. it doesn't matter if some of the files mentioned don't exist #--------- @@ -96,15 +88,14 @@ exclude .coveragerc # (3) file types (path patterns) to skip everywhere global-exclude *.py[cod] global-exclude __pycache__ -#--- -# principles: -# - common directories, files and file-types to be generally ignored -# - all outside version control, temporary non-coding output and cache data -# produced by dev processes, automation or user tools -# - by having this section LAST, it can remove files which might have been added by -# previous sections -- such as python compiler cache files -# - can include this section as **boilerplate** : -# - won't all exist in every repo, but including them all does no harm + # principles: + # - common directories, files and file-types to be generally ignored + # - all outside version control, temporary non-coding output and cache data + # produced by dev processes, automation or user tools + # - by having this section LAST, it can remove files which might have been added by + # previous sections -- such as python compiler cache files + # - can include this section as **boilerplate** : + # - won't all exist in every repo, but including them all does no harm #