scribe-org / scribe-org/Scribe-Data
[Epic] Scribe-Data complexipy refactors
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 64
- Forks
- 103
- Avg merge
- 1h 7m
- Merged PRs (30d)
- 1
Description
Terms
- I have searched open and closed issues
- I agree to follow Scribe-Data's Code of Conduct
Issue
[!NOTE]
- This issue is blocked by #617 and #669 where the final features of Scribe-Data will be completed. This issue is also blocked by #623 as we need the tests to be more robust before these refactors are done.
Scribe-data currently has a very high degree of complexity that makes it difficult to maintain at times. This can be seen in the complexipy-snapshot.json file that is derived via uv run complexipy src/scribe_data/ --snapshot-create. The goal of this epic is to reduce the complexity of Scribe-Data down such that all functions meet a maximum complexity of 15.
We can make sub-issues for separate functions as needed :)
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 reading complexipy-snapshot.json and running uv run complexipy src/scribe_data/ --snapshot-create to identify functions above the complexity threshold. Review blockers #617, #669, and #623 before selecting a function or creating a sub-issue. Done means the relevant functions meet the maximum complexity of 15 without weakening the tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data-engineering, tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100