Openfisca-core

- In Python, simplify simulation initialisation:

Before:

py
simulation = ...
holder = simulation.persons.get_holder('salary')
holder.set_input('2018-08', [4000])


After:

py
simulation = ...
simulation.set_input('salary', '2018-08', [4000])

- In Python, allow multiline documentation on parameters and variables
- Introduce `documentation` attribute on `ParameterNode`, `Parameter` and `Variable` classes

- In the Web API, expose this documentation as a `documentation` property for parameters, variables and variables' formulas
- on `/parameter` nodes as `/parameter/benefits`
> = python `ParameterNode.documentation`
> = YAML parameter node (`index.yaml`) `documentation` string attribute
- on `/parameter` leafs as `/parameter/benefits/housing_allowance`
> = python `Parameter.documentation`
> = YAML parameter `documentation` string attribute
- on `/variable` as `/variable/housing_allowance`
> = python `Variable.documentation`
- on every `/variable` leaf formula
> = python `Variable` formula **docstring**

- Add a style formatter that follows community code conventions
- Auto-fix code formatting

- Fix small issues in the `/spec` route of the Web API
- Use proper JSON Schema type to describe input types
- Fix property name in the description of `/parameters` and `/variables`

- Introduce the `/entities` endpoint for the Web API.
- Expose information about the country package's entities, and their roles.
json
{
"description": "Household",
"documentation": "Household is an example of a group entity. A group entity contains one or more individual·s.[...]",
"plural": "households",
"roles": {
"parent": {
"description": "The one or two adults in charge of the household.",
"max": 2,
"plural": "parents"
},
"child": {
"description": "Other individuals living in the household.",
"plural": "children"
}
}
}

- Allow to dump and restore a simulation in a directory

Dump:

py
from openfisca_core.tools.simulation_dumper import dump_simulation
dump_simulation(simulation, '/path/to/directory')


Restore:

py
from openfisca_core.tools.simulation_dumper import restore_simulation
simulation = restore_simulation('/path/to/directory', tax_benefit_system)