Skip to content

Commit

Permalink
MNT: Move cartopy feature download script into the package
Browse files Browse the repository at this point in the history
Move it from the tools directory into the feature module and make
it an executable module by calling it __main__.py

It can be invoked with `python -m cartopy.feature.download` now.
  • Loading branch information
greglucas committed Oct 20, 2023
1 parent 53260b6 commit 30b4135
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 4 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/ci-testing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,9 @@ jobs:
shell: bash
run: |
# Check that the downloader tool at least knows where to get the data from (but don't actually download it)
python tools/cartopy_feature_download.py gshhs physical --dry-run
python -m cartopy.feature.download gshhs physical --dry-run
# It should also be available as a script
cartopy_feature_download gshhs physical --dry-run
CARTOPY_GIT_DIR=$PWD
pytest -ra -n 4 \
--color=yes \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
For detail on how to use this tool, execute it with the `-h` option:
python cartopy_feature_download.py -h
python -m cartopy.feature.download -h
"""

Expand Down Expand Up @@ -107,7 +107,7 @@ def download_features(group_names, dry_run=True):
''.format(category, name, scale, len(geoms)))


if __name__ == '__main__':
def main():
parser = argparse.ArgumentParser(description='Download feature datasets.')
parser.add_argument('group_names', nargs='+',
choices=FEATURE_DEFN_GROUPS,
Expand Down Expand Up @@ -146,3 +146,7 @@ def download_features(group_names, dry_run=True):
config['downloaders'][SHP_NE_SPEC].url_template = URL_TEMPLATE

download_features(args.group_names, dry_run=args.dry_run)


if __name__ == '__main__':
main()
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ plotting = ["pillow>=6.1.0", "scipy>=1.3.1"]
test = ["pytest>=5.1.2", "pytest-mpl>=0.11", "pytest-xdist", "pytest-cov", "coveralls"]

[project.scripts]
feature_download = "tools.cartopy_feature_download.py:__main__"
cartopy_feature_download = "cartopy.feature.download.__main__:main"

[project.urls]
documentation='https://scitools.org.uk/cartopy/docs/latest/'
Expand Down

0 comments on commit 30b4135

Please sign in to comment.