PolicyEngine / PolicyEngine/policyengine-core

Add custom time periods

Open
#1 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
22
Forks
30
Avg merge
14h 33m
Merged PRs (30d)
7

Description

We should allow country packages to define their own time periods. For example, the UK fiscal year begins on the 1st of April. I think the cleanest implementation would involve the Period class having period-specific features removed, and adding base classes Day, Month, Year and Eternity inherit from Period.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing Period class and how its period-specific behavior is used. Define what must change so country packages can provide custom time periods, then verify that Day, Month, Year, and Eternity can inherit from Period without retaining period-specific features in the base class.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.