# OpenFisca Extension-Template
This repository is here to help you bootstrap your own OpenFisca [extension](http://openfisca.org/doc/contribute/extensions.html) package.
**You should NOT fork it but [download a copy](https://github.com/openfisca/extension-template/archive/master.zip) of its source code** and
- change the name `openfisca_extension_template` to reflect your extension's name, e.g. `openfisca_shangrila`
- empty out CHANGELOG.md
- replace the placeholders variables and parameters to suit your own purposes
## Installing
> We recommend that you [use a virtualenv](https://github.com/openfisca/country-template/blob/master/README.md#setting-up-a-virtual-environment-with-pew) 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 extension, run:
```sh
make install
```
## Testing
You can make sure that everything is working by running the provided tests:
```sh
make test
```
> [Learn more about tests](http://openfisca.org/doc/coding-the-legislation/writing_yaml_tests.html).
Your extension package is now installed and ready!
Raw data
{
"_id": null,
"home_page": "https://github.com/openfisca/extension-template",
"name": "OpenFisca-Extension-Template",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "benefit microsimulation social tax",
"author": "OpenFisca Team",
"author_email": "contact@openfisca.org",
"download_url": "https://files.pythonhosted.org/packages/28/a9/697db838fb4bc8238de2062de2ad7ebb4075e16242f5a4926d7fbab06de3/OpenFisca-Extension-Template-1.3.14.tar.gz",
"platform": null,
"description": "# OpenFisca Extension-Template\n\nThis repository is here to help you bootstrap your own OpenFisca [extension](http://openfisca.org/doc/contribute/extensions.html) package.\n\n**You should NOT fork it but [download a copy](https://github.com/openfisca/extension-template/archive/master.zip) of its source code** and\n- change the name `openfisca_extension_template` to reflect your extension's name, e.g. `openfisca_shangrila`\n- empty out CHANGELOG.md\n- replace the placeholders variables and parameters to suit your own purposes\n\n## Installing\n\n> We recommend that you [use a virtualenv](https://github.com/openfisca/country-template/blob/master/README.md#setting-up-a-virtual-environment-with-pew) to install OpenFisca. If you don't, you may need to add `--user` at the end of all commands starting by `pip`.\n\nTo install your extension, run:\n\n```sh\nmake install\n```\n\n## Testing\n\nYou can make sure that everything is working by running the provided tests:\n\n```sh\nmake test\n```\n\n> [Learn more about tests](http://openfisca.org/doc/coding-the-legislation/writing_yaml_tests.html).\n\nYour extension package is now installed and ready!\n",
"bugtrack_url": null,
"license": "http://www.fsf.org/licensing/licenses/agpl-3.0.html",
"summary": "An OpenFisca extension that adds some variables to an already-existing tax and benefit system",
"version": "1.3.14",
"project_urls": {
"Homepage": "https://github.com/openfisca/extension-template"
},
"split_keywords": [
"benefit",
"microsimulation",
"social",
"tax"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f186dad801ba79af24c73eae3d79a3b6839e13bf73d402183b0c6e36502feebe",
"md5": "4c5c389e3aea48884d4e94efab38f5da",
"sha256": "7f27c896f8d9aa2104c564526ff99b93f6bcf5e3fd8688675e63c169b5f7c96a"
},
"downloads": -1,
"filename": "OpenFisca_Extension_Template-1.3.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4c5c389e3aea48884d4e94efab38f5da",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20172,
"upload_time": "2024-06-28T16:21:23",
"upload_time_iso_8601": "2024-06-28T16:21:23.700196Z",
"url": "https://files.pythonhosted.org/packages/f1/86/dad801ba79af24c73eae3d79a3b6839e13bf73d402183b0c6e36502feebe/OpenFisca_Extension_Template-1.3.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "28a9697db838fb4bc8238de2062de2ad7ebb4075e16242f5a4926d7fbab06de3",
"md5": "b7f1c4251beba31d64043f0a00aefc63",
"sha256": "e8784f6880f9234925664f8e29b658dad70c994603f3ccc951770cdd73385f8f"
},
"downloads": -1,
"filename": "OpenFisca-Extension-Template-1.3.14.tar.gz",
"has_sig": false,
"md5_digest": "b7f1c4251beba31d64043f0a00aefc63",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17746,
"upload_time": "2024-06-28T16:21:26",
"upload_time_iso_8601": "2024-06-28T16:21:26.356951Z",
"url": "https://files.pythonhosted.org/packages/28/a9/697db838fb4bc8238de2062de2ad7ebb4075e16242f5a4926d7fbab06de3/OpenFisca-Extension-Template-1.3.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-28 16:21:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openfisca",
"github_project": "extension-template",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "openfisca-extension-template"
}
JSON
