Skip to content

docs: Add python-ort reference in documentation #9930

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

heliocastro
Copy link
Contributor

No description provided.

@heliocastro heliocastro self-assigned this Feb 13, 2025
@heliocastro heliocastro requested a review from a team as a code owner February 13, 2025 10:20
Copy link

codecov bot commented Feb 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.43%. Comparing base (a25942a) to head (11868c7).

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #9930      +/-   ##
============================================
- Coverage     68.46%   68.43%   -0.03%     
  Complexity     1309     1309              
============================================
  Files           250      250              
  Lines          8881     8881              
  Branches        924      924              
============================================
- Hits           6080     6078       -2     
- Misses         2409     2412       +3     
+ Partials        392      391       -1     
Flag Coverage Δ
funTest-non-docker 33.36% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


## Python-Ort

[Python-Ort](https://github.com/heliocastro/python-ort) is a pydantic based library to serialize OSS Review Toolkit generated reports using the default models. Instructions to install are available on [Python Ort Test PyPI Registry](https://test.pypi.org/project/python-ort/)
Copy link
Member

Choose a reason for hiding this comment

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

  • "pydantic-based"
  • Should it be "de*serialize" instead?
  • Maybe better "reports generated by ORT"?
  • "available on the"
  • Missing dot at the end of the last sentence.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed. Good to go ?

Copy link
Member

Choose a reason for hiding this comment

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

I believe that @mnonnenmacher should review this primarily as it was his suggestion to add it here.

Copy link
Member

Choose a reason for hiding this comment

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

@heliocastro Can you please squash the two commits?
Also, shouldn't it be just "Python-Ort PyPI Registry" (without "Test")?

Copy link
Member

Choose a reason for hiding this comment

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

@mnonnenmacher, can you please have another look at the updated PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mnonnenmacher Is Test Pypi because is not ready to move to main registry yet.

Copy link
Member

Choose a reason for hiding this comment

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

@heliocastro Can you please squash the two commits and get rid of the merge commit?

Copy link
Member

Choose a reason for hiding this comment

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

Ping @heliocastro, please see the comment above, which is still valid.

Signed-off-by: Helio Chissini de Castro <[email protected]>
Signed-off-by: Helio Chissini de Castro <[email protected]>
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.

3 participants