openlibhums / openlibhums/janeway
KBART: Add support for plugin hooks
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 238
- Forks
- 97
- Avg merge
- 9d 1h
- Merged PRs (30d)
- 8
Description
Is your feature request related to a problem? Please describe.
When using plugins for additional publication formats within Janeway (e.g. books), our APIs will largely ignore these publications
Describe the solution you'd like
A plugin hook that allows plugins to extend or modify the generation of the KBART files from the KBART endpoint
Describe alternatives you've considered
Plugins can expose their own endpoints, however for press-wide metadata, hooks are still necessary
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the KBART endpoint and the code that generates KBART files, then inspect how Janeway plugins expose extension points. Define the hook's scope for allowing plugins to extend or modify generated files, and verify that plugin-provided publication formats are included without breaking existing endpoint behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100