Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Serve household reports at /v2/reports

Offen
  • Stimmt etwas nicht?
#4,131 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 2 Tagen

@anth-volk arbeitet bereits daran.

Seit 29.10.2026.

  • #4132 von @anth-volk — offen

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
48/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
python
Bereich
api, backend

Rechercherichtung

Start by tracing the existing economy report routes and simulation service flow for POST /v2/reports, report reads, reruns, and saved reports. Then follow the household and policy validation paths described in the issue, including country checks and default-year handling. Done means household reports can be created, read, rerun, and saved by ID, including for household-only countries, while the specified invalid requests are rejected.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

What

Add the household kind of /v2/reports. A household report calculates a household stored through /v2/households under a baseline policy and an optional reform policy, each a stored /v2/policies policy or current law, for the household's default year. The simulation service calculates and stores it, as it does economy reports.

  • POST /v2/reports accepts kind: "household" with the household and the policies.
  • GET /v2/reports/{report_id} and GET /v2/reports?report_id=… read household reports beside economy reports.
  • POST /v2/reports/{report_id}/runs runs a household report again, with force to recalculate.
  • Saved reports (/v2/user-reports) accept household report IDs.

It works for any country whose countries row has household_enabled, including a household-only country, where economy reports are refused with 422.

Why

The newer app interface needs persisted, shareable household reports with their own IDs once it moves to the v2 routes, and the economy kind of /v2/reports cannot hold a household. Before asking the simulation service, the Public API checks what it decides itself: that the country has household calculations, that the household and policies are the country's, and that the household has a default year. The simulation service reads the household and policies from the Public API's tables itself, so the Public API sends only their IDs.

Vorherrschende Sprache
Python
Sterne
18
Forks
33
Ø Merge
2 T. 3 Std.
Gemergte PRs (30 T.)
72

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus PolicyEngine/policyengine-api

Alle Issues in PolicyEngine/policyengine-api

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.