Transport-for-the-North/caf.distribute

Gravity Model Results Base Class

Open

#50 opened on Nov 8, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (4 forks)auto 404
buggood first issuequestion

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (PR metrics pending)

Description

GravityModelResults seems to only act as a base class for the other results, if this is the case it could be renamed to GravityModelResultsBase and inherit from abc.ABC to make it clearer the intention of the class. Additionally an abstract property for summary should be added.

https://github.com/Transport-for-the-North/caf.distribute/blob/e407015087e802eb12164defda70f340cd57d7f6/src/caf/distribute/gravity_model/core.py#L29-L60

Contributor guide

Research direction
Review the current GravityModelResults class, rename to GravityModelResultsBase, ensure it inherits from abc.ABC, and add an abstract property for summary.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75