search

bcgov / traction

Traction is designed with an API-first architecture layered on top of Hyperledger Aries Cloud Agent Python (ACA-Py) and streamlines the process of sending and receiving digital credentials for governments and organizations.
https://digital.gov.bc.ca/digital-trust/tools/traction/
Apache License 2.0
52 stars 51 forks source link

Innkeeper plugin: normalize formatting/linting tools with other plugins #1406

Open loneil opened 1 week ago

loneil commented 1 week ago

The Innkeeper plugin has black and flake8 set up as dev dependencies (https://github.com/bcgov/traction/blob/main/plugins/traction_innkeeper/pyproject.toml#L21). In the plugin repo the plugins are setup to use Ruff instead. We should match build processes for this plugin to the ones in the repo.

Alter dev dependencies and format/lint setup to be like the plugins repo. Make sure any GHA build processes for PRs and merges and such use the same patterns where possible when it comes to lint checks as well.

The innkeeper plugin also needs unit testing additions and dev tools for that should match as well, but that's covered in https://github.com/bcgov/traction/issues/946

loneil commented 1 week ago

Tagging for any additional thoughts @jamshale

jamshale commented 1 week ago

It's not really that important if there's not going to be a lot of changes to this plugin... But, yes it would be good to be consistent with the other plugins.

I think some basic unit testing coverage is more important, and possibly some integration testing like the plugins have. It has caught issues with libraries that aren't going to be caught with innkeeper until manually tested in traction UI.

I think when someone adds some tests they could updating the linting/formatting/docs at the same time.