Skip to content

Latest commit

 

History

History
479 lines (353 loc) · 11.9 KB

CHANGELOG.md

File metadata and controls

479 lines (353 loc) · 11.9 KB
Raw

Changelog

3.9.10 - #86

  • Technical change.
  • Details:
    • Fix installation and building operations by fixing the bootstrap script.

3.9.9 - #85

  • Minor change.
  • Details:
    • Add make serve-local command to Makefile.

3.9.8 - #83

  • Minor change.
  • Details:
    • Add additional example JSON file; add to README.

3.9.7 - #80

  • Minor change.
  • Details:
    • Upgrade autopep8

3.9.6 - #78

  • Minor change.
  • Details:
    • Declare package compatible with Core v34

3.9.5 - #76

  • Minor change.
  • Details:
    • Declare package compatible with Core v32

3.9.4 - #75

  • Minor change.
  • Details:
    • Upgrade autopep8

3.9.3 - #73

  • Minor change.
  • Details:
    • Upgrade autopep8

3.9.2 - #71

  • Minor change.
  • Details:
    • Upgrade flake8 and pycodestyle

3.9.1 - #74

  • Minor change.
  • Details:
    • Explicit expected test output

3.9.0 - #72

  • Technical change
  • Details:
    • Declare package compatible with Core v31

3.8.0 - #69

  • Technical change
  • Details:
    • Declare package compatible with Core v27

3.7.0 - #68

  • Technical change
  • Details:
    • Declare package compatible with Core v26
    • Remove Python 2 checks from continuous integration

3.6.O - #66

  • Minor change
  • Details:
    • Adapt to OpenFisca Core v25
    • Change the syntax of OpenFisca YAML tests

For instance, a test that was using the input_variables and the output_variables keywords like:

- name: Basic income
  period: 2016-12
  input_variables:
    salary: 1200
  output_variables:
    basic_income: 600

becomes:

- name: Basic income
  period: 2016-12
  input:
    salary: 1200
  output:
    basic_income: 600

A test that was fully specifying its entities like:

name: Housing tax
  period: 2017-01
  households:
    - parents: [ Alicia ]
      children: [ Michael ]
  persons:
    - id: Alicia
        birth: 1961-01-15
    - id: Michael
        birth: 2002-01-15
  output_variables:
    housing_tax:
      2017: 1000

becomes:

name: Housing tax
  period: 2017-01
  input:
    household:
      parents: [ Alicia ]
      children: [ Michael ]
    persons:
      Alicia:
        birth: 1961-01-15
      Michael:
        birth: 2002-01-15
  output:
    housing_tax:
      2017: 1000

3.5.4 - #65

  • Minor change
  • Details:
    • Update links to the doc

3.5.3 - #64

  • Minor change
  • Details:
    • Document housing tax

3.5.2 - #59 #62 #63

  • Technical change
  • Details:
    • Tests library against its packaged version
    • By doing so, we prevent some hideous bugs

Note: Version 3.5.1 has been unpublished as it accidentally introduced a bug. Please use version 3.5.2 or more recent.

3.5.0 - #58

  • Technical change
    • In the /spec Web API route, use examples that apply to this country package

3.4.0

  • Tax and benefit system evolution.
  • Impacted periods: all.
  • Impacted areas: housing
  • Details:
    • Introduce code_postal variable

3.3.2

  • Minor change
  • Details:
    • Update entities labels

3.3.1 - #53

  • Minor change
  • Details:
    • Add documentation to parameters: benefits node and benefits/housing_allowance
    • Add documentation to housing_allowance variable and formula

3.3.0 - #51

  • Technical change
    • Make package compatible with OpenFisca Core v24
    • Rename development dependencies from test to dev:

3.2.3 - #50

  • Minor change
  • Details:
    • Fix repository URL in package metadata

3.2.2 - #49

  • Tax and benefit system evolution.
  • Impacted periods: all.
  • Impacted areas: taxes
  • Details:
    • Implement housing tax minimal amount
  • Minor change
  • Details:
    • Add metadata to parameters

3.2.1 - #47

  • Minor change.
  • Details:
    • Make boostrap script portable.

3.2.0 - #43

  • Tax and benefit system evolution.
  • Impacted periods: all.
  • Impacted areas: demographics
  • Details:
    • Improve reliability and accuracy of age formula
    • Improve variables comments

3.1.3 - #37

  • Minor change.
  • Details:
    • Upgrade openfisca.org references to HTTPS.

3.1.2 - #38

  • Minor change.
  • Details:
    • Add situation example using YAML

3.1.1 - #44

  • Technical improvement.
  • Details:
    • Continuously deploy Python3 package.

3.1.0 - #41

  • Technical improvement.
  • Details:
    • Make package compatible with Python 3

3.0.2 - #37

  • Technical change.
  • Declare package compatible with OpenFisca Core v23

3.0.1 - #39

  • Technical change.
  • Declare package compatible with OpenFisca Core v22

3.0.0 - #34

Breaking change

  • Tax and benefit system evolution.
  • Impacted periods: all.
  • Impacted areas: housing
  • Details:
    • Fix spelling by renaming accomodation_size variable to accommodation_size

Other changes

  • Minor change.
  • Impacted areas: no functional impact.
  • Details:
    • Improve spelling

2.1.0 - #29 #30

  • Tax and benefit system evolution
  • Impacted areas:
    • Parameters general
    • Variables benefits
  • Details:
    • Add a parameter and a variable with non ascii characters
      • Introduce age_of_retirement parameter
      • Introduce pension variable

2.0.1 - #24 #27

Note: the 2.0.0 version has been unpublished due to performance issues

Breaking change

  • Details:
    • Upgrade to Core v21
    • Introduce the use of a string identifier to reference Enum items.
    • When setting an Enum (e.g. housing_occupancy_status), set the relevant string identifier (e.g. free_lodger). Indexes (e.g.2) and phrases (e.g. Free Lodgers) cannot be used anymore.
    • The default value is indicated for each Enum variable instead of being implicitly the first item of the enum.

Web API request/response

Before:

"persons": {
    "Bill": {}
},
"households": {
    "_": {
        "parent": ["Bill"]
        "housing_occupancy_status": "Free Lodger"
    }
}

Now:

"persons": {
    "Bill": {}
},
"households": {
    "_": {
        "parent": ["Bill"]
        "housing_occupancy_status": "free_lodger"
    }
}

YAML testing

Before:

name: Household living in a 40 sq. metres accommodation while being free lodgers
  period: 2017
  input_variables:
    accommodation_size:
      2017-01: 40
    housing_occupancy_status:
      2017-01: 2
  output_variables:
    housing_tax: 0

Now:

name: Household living in a 40 sq. metres accommodation while being free lodgers
  period: 2017
  input_variables:
    accommodation_size:
      2017-01: 40
    housing_occupancy_status:
      2017-01: free_lodger
  output_variables:
    housing_tax: 0

Python API

When calculating an enum variable in Python, the output will be an EnumArray.

See more on the OpenFisca-Core changelog.

1.4.0 - #26

  • Technical improvement
  • Details:
    • Upgrade to Core v20

1.3.2 - #25

  • Declare package compatible with OpenFisca Core v19

1.3.1 - #23

  • Technical improvement
  • Details:
    • Declare package compatible with OpenFisca Core v18

1.3.0 - #22

  • Tax and benefit system evolution
  • Impacted periods: all
  • Impacted areas: stats
  • Details:
    • Introduce total_benefits
    • Introduce total_taxes
  • Minor change
  • Details:
    • Introduce situation examples
      • These examples can be imported with: from openfisca_country_template.situation_examples import single, couple

1.2.7 - #21

  • Minor change
    • Use the technical documentation new address

1.2.6 - #20

  • Minor change
    • Document entities

1.2.5 - #17

  • Technical improvement
  • Details:
    • Adapt to version 17.0.0 of Openfisca-Core
    • Transform XML parameter files to YAML parameter files.

1.2.4 - #16

  • Tax and benefit system evolution
  • Details
    • Introduce housing_occupancy_status
    • Take the housing occupancy status into account in the housing tax

1.2.3 - #9

  • Technical improvement: adapt to version 15.0.0 of Openfisca-Core
  • Details:
    • Rename Variable attribute url to reference

1.2.2 - #12

  • Tax and benefit system evolution
  • Details
    • Allow to declare a yearly amount for salary.
    • The yearly amount will be spread over the months contained in the year

1.2.1 - #11

  • Technical improvement
  • Details:
    • Make make test command not ignore failing tests.

1.2.0 - #10

  • Technical improvement
  • Details:
    • Upgrade OpenFisca-Core
      • Update the way we define formulas start dates and variables stop dates.
      • Update the naming conventions for variable formulas.
      • See the OpenFisca-Core Changelog.

1.1.0 - #7

  • Tax and benefit system evolution
  • Impacted periods: from 2013-01-01
  • Impacted areas:
    • Reform: modify_social_security_taxation
  • Details:
    • Add a reform modifying the brackets of a scale
      • Show how to add, modify and remove a bracket.
      • Add corresponding tests.

1.0.0 - #4

  • Tax and benefit system evolution.
  • Impacted periods: all.
  • Impacted areas:
    • benefits
    • demographics
    • housing
    • income
    • taxes
  • Details:
    • Build the skeleton of the tax and benefit system