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

Downstream type hints? #52

Closed
woodruffw opened this issue Nov 5, 2021 · 6 comments · Fixed by #59
Closed

Downstream type hints? #52

woodruffw opened this issue Nov 5, 2021 · 6 comments · Fixed by #59
Assignees
Labels
enhancement New feature or request

Comments

@woodruffw
Copy link
Contributor

First of all, thanks for this fantastic library!

I'm currently working on using cyclonedx-python-lib to generate SBOMs within pip-audit.

Our codebase is fully typechecked (via MyPy), and it looks like this library is too! But we can't currently consume your type hints, since the cyclonedx package doesn't include a py.typed file per PEP 561.

Is there any objection to including that file, so that downstream users can typecheck their API use? If not, I can go ahead and create a PR -- it should be just a 2 or 3 line change.

@jkowalleck
Copy link
Member

thanks you very much for the hint, @woodruffw 👍
we are currently working on this issue.

@woodruffw
Copy link
Contributor Author

Awesome, thanks a ton! Let me know if I can help with testing or anything else.

@jkowalleck
Copy link
Member

@woodruffw the release v0.11.0 included PEP 561 compatibility.

Could you see if it suites your needs?

@jkowalleck jkowalleck unpinned this issue Nov 10, 2021
@woodruffw
Copy link
Contributor Author

Thanks! I'll test them now.

@woodruffw
Copy link
Contributor Author

Looks like the type hints are working! Thanks a ton for adding them so quickly. The only outstanding issues preventing me from using them are in #61.

@madpah
Copy link
Collaborator

madpah commented Nov 10, 2021

Great news @woodruffw - #61 is merged now and building - point release expected shortly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants