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.

Sign up for GitHub

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

Jump to bottom

Update to implicit namespace package #220

Merged
merged 2 commits into from
Feb 27, 2024
Merged

Update to implicit namespace package #220

merged 2 commits into from
Feb 27, 2024

Conversation

anissa111
Copy link
Member

@anissa111 anissa111 commented Feb 26, 2024 •
edited
Loading

PR Summary

Closes #203
See NCAR/geocat-comp#563

Summary of changes:

  • Converts package to use an implicit namespace
    • removes src/geocat/__init__.py
    • changes in setup.cfg
  • Adds MANIFEST.in to reduce the amount of things that are included with the package (see comparison below).

Note: confirmed that local install of these changes and the changes from NCAR/geocat-comp#563 are installable at once.

Before MANIFEST.in:

(viz_namespace) ➜  geocat-viz git:(namespace) ✗ tar tf dist/*.tar.gz                                
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/.github/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/.github/ISSUE_TEMPLATE/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/.github/ISSUE_TEMPLATE/bug_report.md
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/.github/ISSUE_TEMPLATE/plot-type-request.md
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/.github/ISSUE_TEMPLATE/release.md
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/.github/PULL_REQUEST_TEMPLATE.md
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/.github/dependabot.yml
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/.github/workflows/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/.github/workflows/ci.yml
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/.github/workflows/pre-commit.yml
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/.github/workflows/pypi.yaml
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/.gitignore
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/.pre-commit-config.yaml
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/.readthedocs.yml
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/CITATION.cff
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/CODE_OF_CONDUCT.md
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/CONTRIBUTING.md
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/INSTALLATION.md
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/LICENSE
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/PKG-INFO
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/README.md
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/build_envs/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/build_envs/docs.yml
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/build_envs/environment.yml
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/build_envs/upstream-dev-environment.yml
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/Makefile
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/images/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/images/icons/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/images/icons/code.svg
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/images/icons/download.svg
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/images/icons/electric_bolt.svg
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/images/icons/handshake.svg
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/images/icons/menu_book.svg
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/images/icons/notpublic.svg
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/images/icons/public.svg
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/images/icons/science.svg
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/images/icons/tips.svg
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/images/logos/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/images/logos/GeoCAT_long.svg
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/images/logos/GeoCAT_square.svg
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/images/logos/NSF_NCAR_dark.svg
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/images/logos/NSF_NCAR_light.svg
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/theme_overrides.css
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/thumbnails/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/thumbnails/add_height_from_pressure_axis.png
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/thumbnails/add_lat_lon_gridlines.png
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/thumbnails/add_lat_lon_ticklabels.png
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/thumbnails/add_major_minor_ticks.png
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/thumbnails/add_right_hand_axis.png
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/thumbnails/find_local_extrema.png
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/thumbnails/plot_contour_labels.png
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/thumbnails/plot_extrema_labels.png
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/thumbnails/set_axes_limits_and_ticks.png
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/thumbnails/set_tick_direction_spine_visibility.png
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/thumbnails/set_titles_and_labels.png
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/thumbnails/skewt.png
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_static/thumbnails/taylor.png
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_templates/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_templates/autosummary/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/_templates/autosummary/class.rst
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/api.rst
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/citation.rst
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/conf.py
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/contrib.rst
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/examples/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/examples/add_height_from_pressure_axis.ipynb
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/examples/add_lat_lon_gridlines.ipynb
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/examples/add_lat_lon_ticklabels.ipynb
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/examples/add_major_minor_ticks.ipynb
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/examples/add_right_hand_axis.ipynb
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/examples/find_local_extrema.ipynb
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/examples/get_skewt_vars.ipynb
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/examples/plot_contour_labels.ipynb
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/examples/plot_extrema_labels.ipynb
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/examples/set_axes_limits_and_ticks.ipynb
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/examples/set_tick_direction_spine_visibility.ipynb
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/examples/set_titles_and_labels.ipynb
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/examples/taylor.ipynb
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/examples.rst
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/gallery.yml
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/getting-started.rst
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/getting_started/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/getting_started/overview.rst
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/getting_started/quick-install.rst
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/index.rst
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/installation.rst
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/internal_api/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/internal_api/index.rst
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/make.bat
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/release-notes.rst
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/support.rst
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/user_api/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/docs/user_api/index.rst
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/pyproject.toml
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/setup.cfg
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/setup.py
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat/viz/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat/viz/__init__.py
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat/viz/taylor.py
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat/viz/util.py
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat.viz.egg-info/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat.viz.egg-info/PKG-INFO
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat.viz.egg-info/SOURCES.txt
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat.viz.egg-info/dependency_links.txt
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat.viz.egg-info/not-zip-safe
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat.viz.egg-info/requires.txt
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat.viz.egg-info/top_level.txt

After:

(viz_namespace) ➜  geocat-viz git:(namespace) ✗ tar tf dist/*.tar.gz
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/.pre-commit-config.yaml
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/CITATION.cff
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/CODE_OF_CONDUCT.md
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/CONTRIBUTING.md
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/INSTALLATION.md
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/LICENSE
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/MANIFEST.in
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/PKG-INFO
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/README.md
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/pyproject.toml
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/setup.cfg
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/setup.py
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat/viz/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat/viz/__init__.py
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat/viz/taylor.py
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat/viz/util.py
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat.viz.egg-info/
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat.viz.egg-info/PKG-INFO
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat.viz.egg-info/SOURCES.txt
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat.viz.egg-info/dependency_links.txt
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat.viz.egg-info/not-zip-safe
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat.viz.egg-info/requires.txt
geocat.viz-2021.8.1.dev503+g95a31de.d20240226/src/geocat.viz.egg-info/top_level.txt

PR Checklist

General

  • Make an issue if one doesn't already exist
  • Link the issue this PR resolves by adding closes #XXX to the PR description where XXX is the number of the issue.
  • Add a brief summary of changes to docs/release-notes.rst in a relevant section for the next unreleased release. Possible sections include: Documentation, New Features, Bug Fixes, Internal Changes, Breaking Changes/Deprecated
  • Add appropriate labels to this PR
  • Make your changes in a forked repository rather than directly in this repo
  • Open this PR as a draft if it is not ready for review
  • Convert this PR from a draft to a full PR before requesting reviewers
  • Passes precommit. To set up on your local, run pre-commit install from the top level of the repository. To manually run pre-commits, use pre-commit run --all-files and re-add any changed files before committing again and pushing.

@anissa111 anissa111 added the developer feature For development standardization / best practices / enhancement label Feb 26, 2024
@anissa111 anissa111 marked this pull request as ready for review February 26, 2024 23:48
@anissa111 anissa111 mentioned this pull request Feb 26, 2024
Merged
9 tasks
kafitzgerald
kafitzgerald approved these changes Feb 27, 2024
View reviewed changes
Copy link
Collaborator

@kafitzgerald kafitzgerald left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yeah - this is a bit cleaner than the comp equivalent.

Looks good to me!

@anissa111 anissa111 merged commit 837c783 into NCAR:main Feb 27, 2024
15 checks passed
@anissa111 anissa111 deleted the namespace branch February 27, 2024 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kafitzgerald kafitzgerald kafitzgerald approved these changes

@jukent jukent Awaiting requested review from jukent

Assignees
No one assigned
Labels
developer feature For development standardization / best practices / enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Packaging updates needed for namespace packages
2 participants
@anissa111 @kafitzgerald