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

fix(dist): add py.typed to package_data #90

Merged
merged 1 commit into from
Jul 11, 2024

Conversation

sk-
Copy link
Contributor

@sk- sk- commented Jul 5, 2024

Fixes #89, by adding py.typed to package_data, this was validated by running locally the following commands:

$ pip wheel .
$ unzip -l puremagic-1.25-py3-none-any.whl
Archive:  puremagic-1.25-py3-none-any.whl
  Length      Date    Time    Name
---------  ---------- -----   ----
      102  07-05-2024 13:59   puremagic/__init__.py
       90  07-05-2024 13:59   puremagic/__main__.py
   143189  07-05-2024 13:59   puremagic/magic_data.json
    15622  07-05-2024 13:59   puremagic/main.py
        0  07-05-2024 13:59   puremagic/py.typed
     1086  07-05-2024 14:02   puremagic-1.25.dist-info/LICENSE
     5854  07-05-2024 14:02   puremagic-1.25.dist-info/METADATA
       91  07-05-2024 14:02   puremagic-1.25.dist-info/WHEEL
       10  07-05-2024 14:02   puremagic-1.25.dist-info/top_level.txt
      775  07-05-2024 14:02   puremagic-1.25.dist-info/RECORD
---------                     -------
   166819                     10 files

Note how the py.typed file is now included in the generated wheel.

Fixes cdgriffith#89, by adding `py.typed` to `package_data`, this was validated by running locally the following commands:

```sh
$ pip wheel .
$ unzip -l puremagic-1.25-py3-none-any.whl
Archive:  puremagic-1.25-py3-none-any.whl
  Length      Date    Time    Name
---------  ---------- -----   ----
      102  07-05-2024 13:59   puremagic/__init__.py
       90  07-05-2024 13:59   puremagic/__main__.py
   143189  07-05-2024 13:59   puremagic/magic_data.json
    15622  07-05-2024 13:59   puremagic/main.py
        0  07-05-2024 13:59   puremagic/py.typed
     1086  07-05-2024 14:02   puremagic-1.25.dist-info/LICENSE
     5854  07-05-2024 14:02   puremagic-1.25.dist-info/METADATA
       91  07-05-2024 14:02   puremagic-1.25.dist-info/WHEEL
       10  07-05-2024 14:02   puremagic-1.25.dist-info/top_level.txt
      775  07-05-2024 14:02   puremagic-1.25.dist-info/RECORD
---------                     -------
   166819                     10 files
```

Note how the `py.typed` file is now included in the generated wheel.
@sk-
Copy link
Contributor Author

sk- commented Jul 10, 2024

@cdgriffith it'd be great if you could review this PR and make a release

@cdgriffith cdgriffith changed the base branch from master to develop July 10, 2024 23:21
@cdgriffith
Copy link
Owner

Thank you for the ping @sk- !

@cdgriffith cdgriffith merged commit 1a12a25 into cdgriffith:develop Jul 11, 2024
9 checks passed
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.

py.typed is not included in wheel
3 participants