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

Add PEP 561 py.typed file #23

Merged
merged 1 commit into from
Aug 22, 2023
Merged

Conversation

gmgunter
Copy link
Member

Add an empty py.typed file to the top-level Python package in order to conform with PEP 561. The file indicates to downstream distributors and users that the package supports type information.

Currently, we don't have a MANIFEST to indicate that this file should be included in sdists, but I think the best route is to rely on setuptools_scm for this, which will be added in a subsequent PR.

@codecov
Copy link

codecov bot commented Aug 22, 2023

Codecov Report

Merging #23 (d3fa821) into main (ec9b659) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #23   +/-   ##
=======================================
  Coverage   97.63%   97.63%           
=======================================
  Files           9        9           
  Lines         761      761           
=======================================
  Hits          743      743           
  Misses         18       18           

@gmgunter gmgunter merged commit 4f3de0c into isce-framework:main Aug 22, 2023
6 checks passed
@gmgunter gmgunter deleted the pep-561-file branch August 22, 2023 18:17
scottstanie added a commit to isce-framework/dolphin that referenced this pull request Sep 7, 2023
* start outlining change of the split

* remove modules and tests for PGE/netcdf product

* remove pge/product references from `s1_disp`

also move 2 functiosn for `disp-s1` into `_utils`

* remove isce3/pillow/h5netcdf

* add file for unwrapping optinal reqs

* update specfile and extra deps

* rename `scratch` to `work` diretory, remove `output/`

* remove benchmark/release scripts added to `disp-s1`

* add `py.typed` to package to indicate that package is typed

see isce-framework/tophu#23 and https://peps.python.org/pep-0561/#packaging-type-information

* add a check for unwrap optional deps in `stitch_and_unwrap`

* match readme to getting started

* update to setup-micromamba, skip macos/latest for now

* go back to no label on os

* add back in ubuntu
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant