diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..4e2a205b --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,30 @@ +Hi there! + +I really enjoy OpenFisca, but I recently encountered an issue. + +### Here is what I did: + + +### Here is what I expected to happen: + + +### Here is what actually happened: + + +### Here is data (or links to it) that can help you reproduce this issue: + + + +## Context + +I identify more as a: + +- Analyst _(I make macroscopic computations on real populations)_. +- Business expert _(I create tests and model legislation)_. +- Commenter _(I make data visualisations)_. +- Developer _(I create tools that use the existing OpenFisca code)_. +- Historian _(I accumulate data based on past legislation values)_. +- Lobbyist _(I model reforms to make them exist)_. +- Producer _(I make computations on individual situations)_. + +(remove this line as well as all items in the list that don't fit your situation) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..e427fccb --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,17 @@ +Thanks for contributing to OpenFisca ! Please remove this line, as well as, for each line below, the cases which are unrelevant to your contribution :) + +* Tax and benefit system evolution. | Technical improvement. | Crash fix. | Minor change. +* Impacted periods: all. | until DD/MM/YYYY. | from DD/MM/YYYY. +* Impacted areas: `path/to/file/containing/impacted/variables` +* Details: + - New feature or new behaviour description + - Cases for which an error was noticed + +- - - - + +These changes _(remove lines which are unrelevant to your contribution)_: + +- Impact the OpenFisca-Country-Template public API (for instance renaming or removing a variable) +- Add a new feature (for instance adding a variable) +- Fix or improve an already existing calculation. +- Change non-functional parts of this repository (for instance editing the README) diff --git a/.gitignore b/.gitignore index 66dbf51b..c1243517 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,19 @@ +# Python builds + *.egg-info *.pyc +build +dist + +# Editors + +.project +.pydevproject +.settings +.spyderproject +.vscode + +# OS stuff + +.DS_Store +*~ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..1f787b7d --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,12 @@ +# 1.0.0 - [#4](https://github.com/openfisca/country-template/pull/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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..4abf2572 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,98 @@ +> This file defines the rules to follow to contribute to your repository. +> The rules suggested here are what we generally use for OpenFisca country packages. +> You can of course edit them, and you should probably remove this block :) + +Thank you for wanting to contribute to OpenFisca! :smiley: + +TL;DR: [GitHub Flow](https://guides.github.com/introduction/flow/), [SemVer](http://semver.org/). + + +## Pull requests + +We follow the [GitHub Flow](https://guides.github.com/introduction/flow/): all code contributions are submitted via a pull request towards the `master` branch. + +Opening a Pull Request means you want that code to be merged. If you want to only discuss it, send a link to your branch along with your questions through whichever communication channel you prefer. + +### Peer reviews + +All pull requests must be reviewed by someone else than their original author. + +> In case of a lack of available reviewers, one may review oneself, but only after at least 24 hours have passed without working on the code to review. + +To help reviewers, make sure to add to your PR a **clear text explanation** of your changes. + +In case of breaking changes, you **must** give details about what features were deprecated. + +> You must also provide guidelines to help users adapt their code to be compatible with the new version of the package. + + +## Advertising changes + +### Version number + +We follow the [semantic versioning](http://semver.org/) spec: any change impacts the version number, and the version number conveys API compatibility information **only**. + +Examples: + +#### Patch bump + +- Fixing or improving an already existing calculation. + +#### Minor bump + +- Adding a variable to the tax and benefit system. + +#### Major bump + +- Renaming or removing a variable from the tax and benefit system. + +### Changelog + +OpenFisca-Country-Template changes must be understood by users who don't necessarily work on the code. The Changelog must therefore be as explicit as possible. + +Each change must be documented with the following elements: + +- On the first line appears as a title the version number, as well as a link towards the Pull Request introducing the change. The title level must match the incrementation level of the version. + + +> For instance : +> # 13.0.0 - [#671](https://github.com/openfisca/openfisca-france/pull/671) +> +> ## 13.2.0 - [#676](https://github.com/openfisca/openfisca-france/pull/676) +> +> ### 13.1.5 - [#684](https://github.com/openfisca/openfisca-france/pull/684) + +- The second line indicates the type of the change. The possible types are: + - `Tax and benefit system evolution`: Calculation improvement, fix, or update. Impacts the users interested in calculations. + - `Technical improvement`: Performances improvement, installing process change, formula syntax change… Impacts the users who write legislation and/or deploy their own instance. + - `Crash fix`: Impact all reusers. + - `Minor change`: Refactoring, metadata… Has no impact on users. + +- In the case of a `Tax and benefit system evolution`, the following elements must then be specified: + - The periods impacted by the change. To avoid any ambiguity, the start day and/or the end day of the impacted periods must be precised. For instance, `from 01/01/2017` is correct, but `from 2017` is not, as it is ambiguous: it is not clear wheter 2017 is included or not in the impacted period. + - The tax and benefit system areas impacted by the change. These areas are described by the relative paths to the modified files, without the `.py` extension. + +> For instance : +> - Impacted periods: Until 31/12/2015. +> - Impacted areas: `benefits/healthcare/universal_coverage` + +- Finally, for all cases except `Minor Change`, the changes must be explicited by details given from a user perspective: in which case was an error or a problem was noticed ? What is the new available feature ? Which new behaviour is adopted. + +> For instance: +> +> * Details : +> - These variables now return a yearly amount (instead of monthly): +> - `middle_school_scholarship` +> - `high_school_scholarship` +> - _The previous monthly amounts were just yearly amounts artificially divided by 12_ +> +> or : +> +> * Details : +> - Use OpenFisca-Core `12.0.0` +> - Change the syntax used to declare parameters: +> - Remove "fuzzy" attribute +> - Remove "end" attribute +> - All parameters are assumed to be valid until and end date is explicitely specified with an `` tag + +When a Pull Request contains several disctincts changes, several paragraphs may be added to the Changelog. To be properly formatted in Markdown, these paragraphs must be separated by ``. diff --git a/LICENSE.AGPL.txt b/LICENSE.AGPL.txt new file mode 100644 index 00000000..1ce87587 --- /dev/null +++ b/LICENSE.AGPL.txt @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in index 645b9a7c..1d81d275 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1 +1 @@ -include openfisca_country_template/parameters.xml +recursive-include * * diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..036705af --- /dev/null +++ b/Makefile @@ -0,0 +1,7 @@ +clean: + rm -rf build dist + find . -name '*.pyc' -exec rm \{\} \; + +test: + flake8 + nosetests diff --git a/README.md b/README.md index 096e8053..2fa9f4f6 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,14 @@ -# OpenFisca country package template +# OpenFisca Country-Template This repository is here to help you quickly bootstrap and use your own OpenFisca country package. - ## Bootstrapping a country package - This set of instructions will create your own copy of this boilerplate directory and customise it to the country you want to work on: ```sh COUNTRY_NAME=France # set the name of your country here; you should keep all capitals, and replace any spaces in the name by underscores +URL=https://github.com/openfisca/openfisca-france # set here the URL of the repository where you will publish your code. lowercase_country_name=$(echo $COUNTRY_NAME | tr '[:upper:]' '[:lower:]') @@ -19,32 +18,50 @@ git clone https://github.com/openfisca/country-template.git # download this tem mv country-template openfisca-$lowercase_country_name cd openfisca-$lowercase_country_name git remote remove origin -sed -i '' "s/country_template/$lowercase_country_name/g" MANIFEST.in openfisca_country_template/base.py openfisca_country_template/model.py -sed -i '' "s/Country-Template/$COUNTRY_NAME/g" setup.py +sed -i '' '3,27d' README.md # Remove these instructions lines +sed -i '' "s|country_template|$lowercase_country_name|g" README.md setup.py check-version-bump.sh `find openfisca_country_template -type f` +sed -i '' "s|Country-Template|$COUNTRY_NAME|g" README.md setup.py check-version-bump.sh .github/PULL_REQUEST_TEMPLATE.md CONTRIBUTING.md `find openfisca_country_template -type f` +sed -i '' "s|https://github.com/openfisca/openfisca-country-template|$URL|g" setup.py mv openfisca_country_template openfisca_$lowercase_country_name -rm README.md ``` -## Installation +## Writing the legislation + +The country whose law is modelled here has a very simple tax and benefit system. + +- It has a flat rate tax whose rates increase every year. +- On the first of December, 2015, it introduced a basic income for all its citizens of age who have no income. +- On the first of December, 2016, it removed the income condition, providing all its adult citizens with a basic income. + +These elements are described in different folders. All the modelling happens within the `openfisca_country_template` folder. + +- The rates are in the `parameters` folder. +- The formulas are in the `variables` folder. + +The files that are outside from the `openfisca_country_template` folder are used to set up the development environment. + + +## Installing > We recommend that you [use a virtualenv](https://doc.openfisca.fr/for_developers.html#create-a-virtualenv) to install OpenFisca. If you don't, you may need to add `--user` at the end of all commands starting by `pip`. To install your country package, run: ``` -pip install -e . +pip install -e ".[test]" ``` -You can make sure that everything is working by running the provided test: +You can make sure that everything is working by running the provided tests: ```sh -openfisca-run-test openfisca_$COUNTRY_NAME/test.yaml +make test ``` > [Learn more about tests](https://doc.openfisca.fr/coding-the-legislation/writing_yaml_tests.html) Your country package is now installed and ready! + ## Serving your country package with the OpenFisca web API If you are considering building a web application, you can plug the OpenFisca web api to your country package. @@ -54,7 +71,7 @@ First, install the OpenFisca web API: pip install -e '.[api]' ``` -Then run : +Then run: ```sh openfisca-serve --port 2000 ``` @@ -65,4 +82,4 @@ You can make sure that the api is working by requesting: curl "http://localhost:2000/api/2/formula/income_tax?salary=4000" ``` -> [Learn more about the api](https://doc.openfisca.fr/openfisca-web-api/index.html) +> [Learn more about the API](https://doc.openfisca.fr/openfisca-web-api/index.html) diff --git a/check-version-bump.sh b/check-version-bump.sh new file mode 100755 index 00000000..e6350624 --- /dev/null +++ b/check-version-bump.sh @@ -0,0 +1,25 @@ +#! /usr/bin/env bash + +current_version=`python setup.py --version` + +if git diff-index --quiet origin/master openfisca_country_template +then exit 0 # there are no changes at all, the version is correct +fi + +if git rev-parse --verify --quiet $current_version +then + echo "Version $current_version already exists:" + git log -1 $current_version + echo + echo "Update the version number in setup.py before merging this branch into master." + echo "Look at the CONTRIBUTING.md file to learn how the version number should be updated." + exit 1 +fi + +if git diff-index --quiet origin/master CHANGELOG.md +then + echo "CHANGELOG.md has not been modified, while the code has changed." + echo "Explain what you changed before merging this branch into master." + echo "Look at the CONTRIBUTING.md file to learn how to write the changelog." + exit 2 +fi diff --git a/circle.yml b/circle.yml new file mode 100644 index 00000000..0a2f638b --- /dev/null +++ b/circle.yml @@ -0,0 +1,26 @@ +machine: + python: + version: 2.7.12 # this specific version is preinstalled on the CI servers and allows faster builds + env: + PYPI_USERNAME: openfisca-bot # set here the name of your Pypi account to automatically publish your template to Pypi + # PYPI_PASSWORD: this value is set in CircleCI's web interface; do not set it here, it is a secret! + +dependencies: + override: + - pip install --upgrade pip wheel # pip >= 8.0 needed to be compatible with "manylinux" wheels, used by numpy >= 1.11 + - pip install twine + - pip install .[test] --upgrade +test: + pre: + - git fetch + override: + - make test + - ./check-version-bump.sh +deployment: + master: + branch: master + commands: + - git tag `python setup.py --version` + - git push --tags # update the repository version + - python setup.py bdist_wheel # build this package in the dist directory + - twine upload dist/* --username $PYPI_USERNAME --password $PYPI_PASSWORD # publish diff --git a/openfisca_country_template/__init__.py b/openfisca_country_template/__init__.py index f40016d4..00c8ee98 100644 --- a/openfisca_country_template/__init__.py +++ b/openfisca_country_template/__init__.py @@ -8,18 +8,26 @@ COUNTRY_DIR = os.path.dirname(os.path.abspath(__file__)) -MODEL_FILE = os.path.join(COUNTRY_DIR, 'model.py') -PARAM_FILE = os.path.join(COUNTRY_DIR, 'parameters.xml') -# Our country tax and benefit class, which inherits from the general TaxBenefitSystem class -# The name CountryTaxBenefitSystem must not be changed, as all tools of the OpenFisca ecosystem expect a CountryTaxBenefitSystem class to be exposed in the __init__ module of a country package + +# Our country tax and benefit class inherits from the general TaxBenefitSystem class. +# The name CountryTaxBenefitSystem must not be changed, as all tools of the OpenFisca ecosystem expect a CountryTaxBenefitSystem class to be exposed in the __init__ module of a country package. class CountryTaxBenefitSystem(TaxBenefitSystem): def __init__(self): # We initialize our tax and benefit system with the general constructor super(CountryTaxBenefitSystem, self).__init__(entities.entities) - # We add to our tax and benefit system all the variables defined in model.py - self.add_variables_from_file(MODEL_FILE) + # We add to our tax and benefit system all the variables + self.add_variables_from_directory(os.path.join(COUNTRY_DIR, 'variables')) + + # We add to our tax and benefit system all the legislation parameters defined in the parameters files + param_files = [ + '__root__.xml', + 'benefits.xml', + 'general.xml', + 'taxes.xml', + ] - # We add to our tax and benefit system all the legislation parameters defined in parameters.xml - self.add_legislation_params(PARAM_FILE) + for param_file in param_files: + param_path = os.path.join(COUNTRY_DIR, 'parameters', param_file) + self.add_legislation_params(param_path) diff --git a/openfisca_country_template/base.py b/openfisca_country_template/base.py deleted file mode 100644 index 69c079db..00000000 --- a/openfisca_country_template/base.py +++ /dev/null @@ -1,9 +0,0 @@ -# -*- coding: utf-8 -*- - -# All the objects defined or imported here will be available in all your legislation files - -# Import from openfisca-core the common python objects used to code the legislation in OpenFisca -from openfisca_core.model_api import * - -# Import the entities specifically defined for this tax and benefit system -from openfisca_country_template.entities import Household, Person diff --git a/openfisca_country_template/entities.py b/openfisca_country_template/entities.py index e4414463..af0e9389 100644 --- a/openfisca_country_template/entities.py +++ b/openfisca_country_template/entities.py @@ -1,8 +1,8 @@ # -*- coding: utf-8 -*- -from openfisca_core.entities import build_entity +# This file defines the entities needed by our legislation. -# You can define here the entities you need in your legislation. +from openfisca_core.entities import build_entity Household = build_entity( key = "household", @@ -14,10 +14,11 @@ 'plural': 'parents', 'label': u'Parents', 'max': 2, + 'subroles': ['first_parent', 'second_parent'] }, { 'key': 'child', - 'plural': 'child', + 'plural': 'children', 'label': u'Child', } ] diff --git a/openfisca_country_template/model.py b/openfisca_country_template/model.py deleted file mode 100644 index 9984594b..00000000 --- a/openfisca_country_template/model.py +++ /dev/null @@ -1,26 +0,0 @@ -# -*- coding: utf-8 -*- - -# Import all the python objects necessary to code the legislation in OpenFisca -# This line must be copy pasted to all files defining OpenFisca variables -from openfisca_country_template.base import * - - -# This variable is a pure input: it doesn't have a formula -class salary(Variable): - column = FloatCol - entity = Person - definition_period = MONTH - label = "Salary" - - -# This variable can be calculated from its formula -class income_tax(Variable): - column = FloatCol - entity = Person - definition_period = MONTH - - # The formula to compute the income tax for a given person at a given period - def function(person, period, legislation): - return person('salary', period) * legislation(period).income_tax_rate - - diff --git a/openfisca_country_template/parameters.xml b/openfisca_country_template/parameters.xml deleted file mode 100644 index 66e52617..00000000 --- a/openfisca_country_template/parameters.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/openfisca_country_template/parameters/__root__.xml b/openfisca_country_template/parameters/__root__.xml new file mode 100644 index 00000000..28b87107 --- /dev/null +++ b/openfisca_country_template/parameters/__root__.xml @@ -0,0 +1,4 @@ + + + + diff --git a/openfisca_country_template/parameters/benefits.xml b/openfisca_country_template/parameters/benefits.xml new file mode 100644 index 00000000..a0e26249 --- /dev/null +++ b/openfisca_country_template/parameters/benefits.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/openfisca_country_template/parameters/general.xml b/openfisca_country_template/parameters/general.xml new file mode 100644 index 00000000..bc27ffa2 --- /dev/null +++ b/openfisca_country_template/parameters/general.xml @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/openfisca_country_template/parameters/taxes.xml b/openfisca_country_template/parameters/taxes.xml new file mode 100644 index 00000000..a28322de --- /dev/null +++ b/openfisca_country_template/parameters/taxes.xml @@ -0,0 +1,50 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/openfisca_country_template/reforms/__init__.py b/openfisca_country_template/reforms/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/openfisca_country_template/reforms/flat_social_security_contribution.py b/openfisca_country_template/reforms/flat_social_security_contribution.py new file mode 100644 index 00000000..ac72402a --- /dev/null +++ b/openfisca_country_template/reforms/flat_social_security_contribution.py @@ -0,0 +1,24 @@ +# -*- coding: utf-8 -*- + +# This file defines a reform. +# A reform is a set of modifications to be applied to a reference tax and benefit system to carry out experiments. +# See https://doc.openfisca.fr/reforms.html + + +# Import from openfisca-core the common python objects used to code the legislation in OpenFisca +from openfisca_core.model_api import * + + +# Our reform replace `social_security_contribution` (the "reference" variable) by the following variable. +class social_security_contribution(Variable): + # Variable metadata don't need to be redefined. By default, the reference variable metadatas will be used. + + def function(person, period, legislation): + return person('salary', period) * 0.03 + + +class flat_social_security_contribution(Reform): + # A reform always defines an `apply` method that builds the reformed tax and benefit system from the reference one. + # See https://doc.openfisca.fr/coding-the-legislation/reforms.html#writing-a-reform + def apply(self): + self.update_variable(social_security_contribution) diff --git a/openfisca_country_template/reforms/removal_basic_income.py b/openfisca_country_template/reforms/removal_basic_income.py new file mode 100644 index 00000000..744815b4 --- /dev/null +++ b/openfisca_country_template/reforms/removal_basic_income.py @@ -0,0 +1,17 @@ +# -*- coding: utf-8 -*- + +# This file defines a reform. +# A reform is a set of modifications to be applied to a reference tax and benefit system to carry out experiments. +# See https://doc.openfisca.fr/reforms.html + + +# Import from openfisca-core the common python objects used to code the legislation in OpenFisca +from openfisca_core.model_api import * + + +class removal_basic_income(Reform): + # A reform always defines an `apply` method that builds the reformed tax and benefit system from the reference one. + # See https://doc.openfisca.fr/coding-the-legislation/reforms.html#writing-a-reform + def apply(self): + # Our reform neutralizes the `basic_income` variable. When this reform is applied, calculating `basic_income` will always return its default value, 0. + self.neutralize_variable('basic_income') diff --git a/openfisca_country_template/test.yaml b/openfisca_country_template/test.yaml deleted file mode 100644 index 9f00935f..00000000 --- a/openfisca_country_template/test.yaml +++ /dev/null @@ -1,19 +0,0 @@ -# This is a test file -# It describes situations and their respectives expected outcomes -# You can run this test on your command line using `openfisca-run-test test.yaml` - -- name: "Test about income tax" - description: Someone making 10000 should pay 1500 of taxes - period: 2017-01 - input_variables: - salary: 10000 - output_variables: - income_tax: 1500 - -# - name: "Failing test" -# description: Someone making 10000 should pay 1500 of taxes -# period: 2017-01 -# input_variables: -# salaire: 10000 -# output_variables: -# impot_revenus: 2000 diff --git a/openfisca_country_template/tests/age.yaml b/openfisca_country_template/tests/age.yaml new file mode 100644 index 00000000..33dc4091 --- /dev/null +++ b/openfisca_country_template/tests/age.yaml @@ -0,0 +1,12 @@ + +# Test files describe situations and their expected outcomes +# We can run this test on our command line using `openfisca-run-test age.yaml` + +- name: Person born on the 15th of Jan 1980 + period: 2015-01 + input_variables: + birth: 1980-01-15 + output_variables: + age: + 2015-01: 34 + 2015-02: 35 diff --git a/openfisca_country_template/tests/basic_income.yaml b/openfisca_country_template/tests/basic_income.yaml new file mode 100644 index 00000000..76faef4c --- /dev/null +++ b/openfisca_country_template/tests/basic_income.yaml @@ -0,0 +1,50 @@ +# Test files describe situations and their expected outcomes +# We can run this test on our command line using `openfisca-run-test basic_income.yaml` + +- name: The basic income should be 0 before it was introduced + period: 2015-11 + input_variables: + age: 18 + salary: 0 + output_variables: + basic_income: 0 + +- name: In Dec 2015, an adult with no salary should get a basic income of 600 + period: 2015-12 + input_variables: + salary: 0 + age: 18 + output_variables: + basic_income: 600 + +- name: In Dec 2015, a child with no salary should get no basic income + period: 2015-12 + input_variables: + salary: 0 + age: 17 + output_variables: + basic_income: 0 + +- name: In Dec 2015, an adult with a salary should get no basic income + period: 2015-12 + input_variables: + salary: 1200 + age: 18 + output_variables: + basic_income: 0 + +- name: In Dec 2016, a child with no salary should get no basic income + period: 2016-12 + input_variables: + salary: 0 + age: 17 + output_variables: + basic_income: 0 + +- name: In Dec 2016, an adult with a salary should get a basic income of 600 + period: 2016-12 + input_variables: + salary: 1200 + age: 18 + output_variables: + basic_income: 600 diff --git a/openfisca_country_template/tests/disposable_income.yaml b/openfisca_country_template/tests/disposable_income.yaml new file mode 100644 index 00000000..184e9eaa --- /dev/null +++ b/openfisca_country_template/tests/disposable_income.yaml @@ -0,0 +1,65 @@ +# Test files describe situations and their expected outcomes +# We can run this test on our command line using `openfisca-run-test disposable_income.yaml` + +- name: Person earning no salary in Jan 2015 + period: 2015-01 + input_variables: + salary: 0 + output_variables: + disposable_income: 0 + +- name: Person earning 2500 in Jan 2015 + period: 2015-01 + input_variables: + salary: 2500 + output_variables: + disposable_income: 2025 + +- name: Person earning 10000 in Jan 2015 + period: 2015-01 + input_variables: + salary: 10000 + output_variables: + disposable_income: 8100 + +- name: Person earning no salary in Jan 2016 + period: 2016-01 + input_variables: + salary: 0 + output_variables: + disposable_income: 600 + +- name: Person earning 2500 in Jan 2016 + period: 2016-01 + input_variables: + salary: 2500 + output_variables: + disposable_income: 2025 + +- name: Person earning 10000 in Jan 2016 + period: 2016-01 + input_variables: + salary: 10000 + output_variables: + disposable_income: 8100 + +- name: Person earning no salary in Jan 2017 + period: 2017-01 + input_variables: + salary: 0 + output_variables: + disposable_income: 600 + +- name: Person earning 2500 in Jan 2017 + period: 2017-01 + input_variables: + salary: 2500 + output_variables: + disposable_income: 2675 + +- name: Person earning 10000 in Jan 2017 + period: 2017-01 + input_variables: + salary: 10000 + output_variables: + disposable_income: 8740 diff --git a/openfisca_country_template/tests/housing_allowance.yaml b/openfisca_country_template/tests/housing_allowance.yaml new file mode 100644 index 00000000..8368934a --- /dev/null +++ b/openfisca_country_template/tests/housing_allowance.yaml @@ -0,0 +1,16 @@ +# Test files describe situations and their expected outcomes +# We can run this test on our command line using `openfisca-run-test housing_allowance.yaml` + +- name: In january 2016, a household paying 400 of rent gets an allowance of 100 + period: 2016-01 + input_variables: + rent: 400 + output_variables: + housing_allowance: 100 + +- name: The housing_allowance disappeared in Dec 2016 + period: 2016-12 + input_variables: + rent: 400 + output_variables: + housing_allowance: 0 diff --git a/openfisca_country_template/tests/housing_tax.yaml b/openfisca_country_template/tests/housing_tax.yaml new file mode 100644 index 00000000..4cac2f06 --- /dev/null +++ b/openfisca_country_template/tests/housing_tax.yaml @@ -0,0 +1,18 @@ +# Test files describe situations and their expected outcomes +# We can run this test on our command line using `openfisca-run-test housing_tax.yaml` + +- name: Household living in a 40 sq.meters accomodation + period: 2017 + input_variables: + accomodation_size: + 2017-01: 40 + output_variables: + housing_tax: 400 + +- name: Household living in a 100 sq.meters accomodation + period: 2017 + input_variables: + accomodation_size: + 2017-01: 100 + output_variables: + housing_tax: 1000 diff --git a/openfisca_country_template/tests/income_tax.yaml b/openfisca_country_template/tests/income_tax.yaml new file mode 100644 index 00000000..ffbec6f9 --- /dev/null +++ b/openfisca_country_template/tests/income_tax.yaml @@ -0,0 +1,9 @@ +# Test files describe situations and their expected outcomes +# We can run this test on our command line using `openfisca-run-test income_tax.yaml` + +- name: Someone making 10000 should pay 1500 of taxes + period: 2017-01 + input_variables: + salary: 10000 + output_variables: + income_tax: 1500 diff --git a/openfisca_country_template/tests/social_security_contribution.yaml b/openfisca_country_template/tests/social_security_contribution.yaml new file mode 100644 index 00000000..29e0c72c --- /dev/null +++ b/openfisca_country_template/tests/social_security_contribution.yaml @@ -0,0 +1,45 @@ + +# Test files describe situations and their expected outcomes +# We can run this test on our command line using `openfisca-run-test social_security_contribution.yaml` + +- name: Person earning 2000 in 2013-01 + period: 2013-01 + input_variables: + salary: 2000 + output_variables: + social_security_contribution: 60 + +- name: Person earning 15000 in 2013-01 + period: 2013-01 + input_variables: + salary: 15000 + output_variables: + social_security_contribution: 660 + +- name: Person earning 2000 in 2015-01 + period: 2015-01 + input_variables: + salary: 2000 + output_variables: + social_security_contribution: 80 + +- name: Person earning 15000 in 2015-01 + period: 2015-01 + input_variables: + salary: 15000 + output_variables: + social_security_contribution: 824 + +- name: Person earning 2000 in 2017-01 + period: 2017-01 + input_variables: + salary: 2000 + output_variables: + social_security_contribution: 40 + +- name: Person earning 15000 in 2017-01 + period: 2017-01 + input_variables: + salary: 15000 + output_variables: + social_security_contribution: 816 diff --git a/openfisca_country_template/tests/yaml_tests.py b/openfisca_country_template/tests/yaml_tests.py new file mode 100644 index 00000000..649fd6c3 --- /dev/null +++ b/openfisca_country_template/tests/yaml_tests.py @@ -0,0 +1,24 @@ +#! /usr/bin/env python +# -*- coding: utf-8 -*- + +# This file browses the country package to find tests written in the YAML format and runs them. +# It is usually not necessary to edit it. + +import os + +from nose.tools import nottest +from openfisca_core.tools.test_runner import generate_tests + +from openfisca_country_template import CountryTaxBenefitSystem + +nottest(generate_tests) + +tax_benefit_system = CountryTaxBenefitSystem() + + +def test(): + tests_directory = os.path.abspath(os.path.join(os.path.dirname(__file__))) + test_generator = generate_tests(tax_benefit_system, tests_directory) + + for test in test_generator: + yield test diff --git a/openfisca_country_template/variables/benefits.py b/openfisca_country_template/variables/benefits.py new file mode 100644 index 00000000..3a2f824e --- /dev/null +++ b/openfisca_country_template/variables/benefits.py @@ -0,0 +1,45 @@ +# -*- coding: utf-8 -*- + +# This file defines the variables of our legislation. +# A variable is property of a person, or an entity (e.g. a household). +# See https://doc.openfisca.fr/variables.html + +# Import from openfisca-core the common python objects used to code the legislation in OpenFisca +from openfisca_core.model_api import * +# Import the entities specifically defined for this tax and benefit system +from openfisca_country_template.entities import * + + +class basic_income(DatedVariable): + column = FloatCol + entity = Person + definition_period = MONTH + label = "Basic income provided to adults" + url = "https://law.gov.example/basic_income" # Always use the most official source + + # Since Dec 1st 2016, the basic income is provided to any adult, without considering their income. + @dated_function(start = date(2016, 12, 1)) + def function_from_2016_12(person, period, legislation): + age_condition = person('age', period) >= legislation(period).general.age_of_majority + return age_condition * legislation(period).benefits.basic_income # This '*' is a vectorial 'if'. See https://doc.openfisca.fr/coding-the-legislation/30_case_disjunction.html#simple-multiplication + + # From Dec 1st 2015 to Nov 30 2016, the basic income is provided to adults who have no income. + # Before Dec 1st 2015, the basic income does not exist in the law, and calculating it returns its default value, which is 0. + @dated_function(start = date(2015, 12, 1), stop = date(2016, 11, 30)) + def function_until_2016_12(person, period, legislation): + age_condition = person('age', period) >= legislation(period).general.age_of_majority + salary_condition = person('salary', period) == 0 + return age_condition * salary_condition * legislation(period).benefits.basic_income # The '*' is also used as a vectorial 'and'. See https://doc.openfisca.fr/coding-the-legislation/25_vectorial_computing.html#forbidden-operations-and-alternatives + + +class housing_allowance(Variable): + column = FloatCol + entity = Household + definition_period = MONTH + label = "Housing allowange" + url = "https://law.gov.example/housing_allowance" # Always use the most official source + start_date = date(1980, 1, 1) # This allowance was introduced on the 1st of Jan 1980. Calculating it before this date will always return the variable default value, 0. + stop_date = date(2016, 11, 30) # This allowance was removed on the 1st of Dec 2016. Calculating it before this date will always return the variable default value, 0. + + def function(household, period, legislation): + return household('rent', period) * legislation(period).benefits.housing_allowance diff --git a/openfisca_country_template/variables/demographics.py b/openfisca_country_template/variables/demographics.py new file mode 100644 index 00000000..44a573af --- /dev/null +++ b/openfisca_country_template/variables/demographics.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- + +# This file defines the variables of our legislation. +# A variable is property of a person, or an entity (e.g. a household). +# See https://doc.openfisca.fr/variables.html + +# Import from openfisca-core the common python objects used to code the legislation in OpenFisca +from openfisca_core.model_api import * +# Import the entities specifically defined for this tax and benefit system +from openfisca_country_template.entities import * + +from numpy import datetime64 + + +class age(Variable): + column = IntCol + entity = Person + definition_period = MONTH + label = u"Person's age (in years)" + + # A person's age is computed according to its birth date. + def function(person, period, legislation): + birth = person('birth', period) + return (datetime64(period.date) - birth).astype('timedelta64[Y]') + + +# This variable is a pure input: it doesn't have a formula +class birth(Variable): + column = DateCol(default = date(1970, 1, 1)) # By default, is no value is set for a simulation, we consider the people involed in a simulation to be born on the 1st of Jan 1970. + entity = Person + label = u"Birth date" + definition_period = ETERNITY # This variable cannot change over time. + url = "https://en.wiktionary.org/wiki/birthdate" diff --git a/openfisca_country_template/variables/housing.py b/openfisca_country_template/variables/housing.py new file mode 100644 index 00000000..9f01dc2d --- /dev/null +++ b/openfisca_country_template/variables/housing.py @@ -0,0 +1,26 @@ +# -*- coding: utf-8 -*- + +# This file defines the variables of our legislation. +# A variable is property of a person, or an entity (e.g. a household). +# See https://doc.openfisca.fr/variables.html + +# Import from openfisca-core the common python objects used to code the legislation in OpenFisca +from openfisca_core.model_api import * +# Import the entities specifically defined for this tax and benefit system +from openfisca_country_template.entities import * + + +# This variable is a pure input: it doesn't have a formula +class accomodation_size(Variable): + column = FloatCol + entity = Household + definition_period = MONTH + label = u"Size of the accomodation, in square metters" + + +# This variable is a pure input: it doesn't have a formula +class rent(Variable): + column = FloatCol + entity = Household + definition_period = MONTH + label = u"Rent paid by the household" diff --git a/openfisca_country_template/variables/income.py b/openfisca_country_template/variables/income.py new file mode 100644 index 00000000..2501faf9 --- /dev/null +++ b/openfisca_country_template/variables/income.py @@ -0,0 +1,35 @@ +# -*- coding: utf-8 -*- + +# This file defines the variables of our legislation. +# A variable is property of a person, or an entity (e.g. a household). +# See https://doc.openfisca.fr/variables.html + +# Import from openfisca-core the common python objects used to code the legislation in OpenFisca +from openfisca_core.model_api import * +# Import the entities specifically defined for this tax and benefit system +from openfisca_country_template.entities import * + + +# This variable is a pure input: it doesn't have a formula +class salary(Variable): + column = FloatCol + entity = Person + definition_period = MONTH + label = "Salary" + url = "https://law.gov.example/salary" # Always use the most official source + + +class disposable_income(Variable): + column = FloatCol + entity = Person + definition_period = MONTH + label = "Actual amount available to the person at the end of the month" + url = "https://stats.gov.example/disposable_income" # Some variables represent quantities used in economic models, and not defined by law. Always give the source of your definition. + + def function(person, period, legislation): + return ( + + person('salary', period) + + person('basic_income', period) + - person('income_tax', period) + - person('social_security_contribution', period) + ) diff --git a/openfisca_country_template/variables/taxes.py b/openfisca_country_template/variables/taxes.py new file mode 100644 index 00000000..185471b6 --- /dev/null +++ b/openfisca_country_template/variables/taxes.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- + +# This file defines the variables of our legislation. +# A variable is property of a person, or an entity (e.g. a household). +# See https://doc.openfisca.fr/variables.html + +# Import from openfisca-core the common python objects used to code the legislation in OpenFisca +from openfisca_core.model_api import * +# Import the entities specifically defined for this tax and benefit system +from openfisca_country_template.entities import * + + +class income_tax(Variable): + column = FloatCol + entity = Person + definition_period = MONTH + label = u"Income tax" + url = "https://law.gov.example/income_tax" # Always use the most official source + + # The formula to compute the income tax for a given person at a given period + def function(person, period, legislation): + return person('salary', period) * legislation(period).taxes.income_tax_rate + + +class social_security_contribution(Variable): + column = FloatCol + entity = Person + definition_period = MONTH + label = u"Progressive contribution paid on salaries to finance social security" + url = "https://law.gov.example/social_security_contribution" # Always use the most official source + + def function(person, period, legislation): + salary = person('salary', period) + + # The social_security_contribution is computed according to a marginal scale. + scale = legislation(period).taxes.social_security_contribution + + return scale.calc(salary) + + +class housing_tax(Variable): + column = FloatCol + entity = Household + definition_period = YEAR # This housing tax is defined for a year. + label = u"Tax paid by each household proportionnally to the size of its accommodation" + url = "https://law.gov.example/housing_tax" # Always use the most official source + + def function(household, period, legislation): + # The housing tax is defined for a year, but depends on the `accomodation_size` on the first month of the year. + # Here period is a year. We can get the first month of a year with the following shortcut. + # To build different periods, see https://doc.openfisca.fr/coding-the-legislation/35_periods.html#calculating-dependencies-for-a-specific-period + january = period.first_month + return household('accomodation_size', january) * 10 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 00000000..68274e30 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,9 @@ +# This file configures flake8, a python tool which makes sure our code follow certain standards. + +[flake8] +hang-closing = true +; E251: We prefer `function(x = 1)` over `function(x=1)` +; E501: We do not enforce a maximum line length +; F403, F405: We allow `import *` +; W503: We break lines before binary operators +ignore = E251, E501, F403, F405, W503 diff --git a/setup.py b/setup.py index 0b504296..8296e7c9 100755 --- a/setup.py +++ b/setup.py @@ -7,20 +7,26 @@ setup( name='OpenFisca-Country-Template', - version='0.1.0', + version='1.0.0', author='OpenFisca Team', author_email='contact@openfisca.fr', - description=u'Template of a tax and benefit system for OpenFisca', + description=u'OpenFisca tax and benefit system for Country-Template', keywords='benefit microsimulation social tax', license='http://www.fsf.org/licensing/licenses/agpl-3.0.html', + url='https://github.com/openfisca/openfisca-country-template', include_package_data = True, # Will read MANIFEST.in install_requires=[ - 'OpenFisca-Core >= 6.1.0, < 11.0', + 'OpenFisca-Core >= 12.0.0, < 13.0', ], extras_require = { 'api': [ 'OpenFisca-Web-API >= 4.0.0, < 6.0', ], + 'test': [ + 'flake8', + 'flake8-print', + 'nose', + ] }, packages=find_packages(), test_suite='nose.collector',