Add Weblate Fedora Messaging schema

harriebird commented 1 month ago

Proposed changes

This adds a new schema for Weblate Fedora Messaging. This solves issue fedora_messaging#268.

Checklist

[ ] Lint and unit tests pass locally with my changes.
[ ] I have added tests that prove my fix is effective or that my feature works.
[ ] I have added documentation to describe my feature.
[ ] I have squashed my commits into logic units.
[ ] I have described the changes in the commit messages.

Other information

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 97.72727% with 3 lines in your changes missing coverage. Please review.

Project coverage is 98.25%. Comparing base (45163d1) to head (1c76d96). Report is 108 commits behind head on main.

Files with missing lines	Patch %	Lines
weblate_schemas/messages.py	95.31%	3 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #364 +/- ## =========================================== - Coverage 100.00% 98.25% -1.75% =========================================== Files 3 5 +2 Lines 43 172 +129 =========================================== + Hits 43 169 +126 - Misses 0 3 +3 ``` | [Flag](https://app.codecov.io/gh/WeblateOrg/weblate_schemas/pull/364/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=WeblateOrg) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/WeblateOrg/weblate_schemas/pull/364/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=WeblateOrg) | `98.25% <97.72%> (-1.75%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=WeblateOrg#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

nijel commented 1 month ago

Looks good for the body schema, now we need to wrap it in Python classes (see https://fedora-messaging.readthedocs.io/en/stable/user-guide/messages.html). Maybe header schema will be needed as well (I didn't investigate that).

harriebird commented 1 month ago

Hi everyone, thank you for your comments. The latest commit contains the following changes:

Renamed the message class to WeblateV1Message
Added properties summary and usernames into the WeblateV1Message class
Added entry point
Replaced jsonschema with jsonschema[format] to extend format validation support
Added new tests

harriebird commented 1 month ago

Hi everyone, I just updated the code based on your comments. Below are the changes made:

Reverted changes in setup.py and moved the entry_points declaration to setup.cfg
Transferred fedora-messaging and jsonschema[format] to requirements-test.txt
Updated the summary property implementation
Updated the usernames property implementation
Changed the id property into change_id
Used get method in accessing the body dictionary
Added pip install -e . command in the dependency install of test.yml workflow

nijel commented 2 weeks ago

I've scheduled this for merge because I want to release this package soon anyway. In case we hit some issues later, those can be fixed in the next release.

WeblateOrg / weblate_schemas