OpenFisca-Tunisia-Pension


NameOpenFisca-Tunisia-Pension JSON
Version 3.0.0 PyPI version JSON
download
home_pageNone
SummaryOpenFisca Rules as Code model for Tunisia pensions.
upload_time2024-11-15 11:41:52
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords microsimulation tax benefit pension rac rules-as-code tunisia
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls. 
            # OpenFisca Tunisia Pension - الجباية المفتوحة  تونس، المنح

[![Build Status via Travis CI](https://travis-ci.org/openfisca/openfisca-tunisia-pension.svg?branch=master)](https://travis-ci.org/openfisca/openfisca-tunisia-pension)

## Presentation - التقديم

[OpenFisca](http://www.openfisca.fr/) est un logiciel libre et polyvalent de micro-simulation. Ceci est le code source du module Tunisien dédié aux pensions.

<p align='right'>الجباية المفتوحة برنامج حر و متعدد الكفاءات لمحاكاة النظام الجبائي. هذا هو مصدر البرنامج للوحدة التونسية الخاصة بالمنح </p>

[OpenFisca](https://www.openfisca.fr/en) is a versatile microsimulation free software. This is the source code of the Tunisian pension module.

## Contribution & Contact - المساهمة والاتصال بنا

OpenFisca est un projet de logiciel libre.

Son code source est distribué sous la licence [GNU Affero General Public Licence](http://www.gnu.org/licenses/agpl.html)
version 3 ou ultérieure (cf. [LICENSE](https://github.com/openfisca/openfisca-tunisia-pension/blob/master/LICENSE)).

N'hésitez pas à rejoindre l'équipe de développement OpenFisca ! Pour en savoir plus, une [documentation](https://doc.openfisca.fr/contribute/index.html) est à votre disposition.


<p align='right'> الجباية المفتوحة برنامج حر</p>

<p align='right'> تم توزيع مصدر هذا البرنامج تحت رخصة أفيرو العامة الثالثة أو ما أعلى</p>

<p align='right'>تعالو انضمو إلى فريق الجباية المفتوحة و ساهمو في تطوير البرنامج!
انظرو للموقع الرسمي للمزيد من المعلومات
</p>


OpenFisca is a free software project.

Its source code is distributed under the [GNU Affero General Public Licence](http://www.gnu.org/licenses/agpl.html)
version 3 or later (see [LICENSE](https://github.com/openfisca/openfisca-tunisia-pension/blob/master/LICENSE) file).

Feel free to join the OpenFisca development team! See the [documentation](https://doc.openfisca.fr/contribute/index.html) for more information.

## Documentation

* Documentation générale du projet OpenFisca (tous pays confondus) : https://doc.openfisca.fr
  - Et son [schéma des composants](https://doc.openfisca.fr/#project-components) d'un projet OpenFisca
* Explorateur de la législation couverte par OpenFisca-Tunisia : https://legislation.openfisca.tn
* Wiki OpenFisca-Tunisia Pension : https://github.com/openfisca/openfisca-tunisia-pension/wiki


## Installation

Sous Unix/macOS/Linux, appliquez les étapes qui suivent dans votre Terminal.

Sous Windows, installez un émulateur de terminal (tel que [ConEmu](https://conemu.github.io)) avant de poursuivre.

### Pré-requis : Langage Python & Gestionnaire d'environnement virtuel

Ce projet nécessite l'installation préalable des éléments suivants :
* Le langage [Python 2.7](https://www.python.org/downloads/)
* Le gestionnaire de paquets [pip](https://pip.pypa.io/en/stable/installing/).

Vérifiez alors que la version de python appelée par défaut débute bien par `2.7` :

```
python --version
```

Et pour ce qui suit, les droits d'administrateur pourront vous être demandés selon l'emplacement de l'installation (`sudo` optionnel).

Commencez par installer les éventuelles mises à jour pour la gestion de paquets python avec :

```
sudo pip install --upgrade pip wheel
```

Ensuite, afin de créer un environnement de travail propre et pour vous permettre de faire cohabiter plusieurs contextes de travail en python, nous vous conseillons l'utilisation d'environnements virtuels, dits virtualenv. Il vous faut alors installer un gestionnaire de virtualenv python tel que [pew](https://github.com/berdario/pew) :

```
sudo pip install pew
```

Il vous est désormais possible de créer votre premier environnement dédié à OpenFisca-Tunisia Pension.

### Création d'environnement virtuel

Il vous sera possible de répéter cette étape de multiples fois au cours de vos travaux sur vos projets python.
A chaque fois, vous choisirez un nouveau nom d'environnement.

Soit `pension` le nom que vous auriez choisi pour votre premier environnement virtuel OpenFisca-Tunisia Pension :

```
pew new pension --python=python2.7
# Si demandé, répondez "Y" à la question sur la modification du fichier de configuration de votre shell
```

Usage :
* Vous pouvez sortir du virtualenv en tapant exit (ou Ctrl-D)
* Vous pouvez le réactiver grâce à `pew workon pension`

### Installation du code source

Afin d'interroger ou de modifier OpenFisca-Tunisia Pension, il vous faut installer le code source en local sur votre ordinateur.

Nous supposons que vous avez activé votre environnement virtuel et que vous vous situez dans le répertoire où vous souhaitez placer le projet.

Appliquez alors les commandes suivantes pour récupérer les sources d'OpenFisca-Tunisia Pension et configurer le projet (sans omettre le point en fin de ligne :slightly_smiling_face:) :

```
git clone https://github.com/openfisca/openfisca-tunisia-pension.git
cd openfisca-tunisia-pension
pip install -e .
```

:tada: Félicitations, vous avez désormais terminé l'installation d'OpenFisca Tunisia Pension !

Vous pouvez vérifier que votre environnement fonctionne bien en démarrant les tests tel que décrit dans le paragraphe suivant.

## Test

Nous supposons que vous êtes dans le répertoire `openfisca-tunisia-pension` et que votre environnement virtuel est activé.
Commencez par installer les outils de test avec :

```
pip install -e .[tests]
```

### Test nose

Un test rédigé en python peut être exécuté avec l'outil `nose`. Celui-ci déroulera les fonctions python dont le nom commence par le mot `test`.

Ainsi, pour exécuter le test python `openfisca_tunisia_pension/tests/test_pension.py`, utilisez la commande suivante :

```
nosetests nosetests openfisca_tunisia_pension/tests/test_pension.py
```

Il vous est également possible de n'exécuter qu'un seul test d'un fichier. Dans l'exemple suivant, `test_rsna` sera l'unique test déroulé du fichier `openfisca_tunisia_pension/tests/test_pension.py` :

```
nosetests openfisca_tunisia_pension/tests/test_pension.py:test_rsna
```

### Test yaml

Le format d'un test yaml est décrit dans la [documentation officielle](https://doc.openfisca.fr/coding-the-legislation/writing_yaml_tests.html).

Ainsi, si vous souhaitez exécuter le test yaml `openfisca_tunisia_pension/tests/formulas/pension_rsna.yaml`, utilisez la commande :

```
openfisca-run-test -c openfisca_tunisia_pension openfisca_tunisia_pension/tests/formulas/pension_rsna.yaml
```

### Tout tester

L'ensemble des tests définis dans OpenFisca-Tunisia peut être démarré grâce à la commande suivante :

```
make test
```

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "OpenFisca-Tunisia-Pension",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "microsimulation, tax, benefit, pension, rac, rules-as-code, tunisia",
    "author": null,
    "author_email": "OpenFisca Team <contact@openfisca.org>",
    "download_url": "https://files.pythonhosted.org/packages/27/c9/6e0f799caa81a62d51ca710f84d21021b9a91838a5f3d26917f335519d53/openfisca_tunisia_pension-3.0.0.tar.gz",
    "platform": null,
    "description": "# OpenFisca Tunisia Pension - \u0627\u0644\u062c\u0628\u0627\u064a\u0629 \u0627\u0644\u0645\u0641\u062a\u0648\u062d\u0629  \u062a\u0648\u0646\u0633\u060c \u0627\u0644\u0645\u0646\u062d\n\n[![Build Status via Travis CI](https://travis-ci.org/openfisca/openfisca-tunisia-pension.svg?branch=master)](https://travis-ci.org/openfisca/openfisca-tunisia-pension)\n\n## Presentation - \u0627\u0644\u062a\u0642\u062f\u064a\u0645\n\n[OpenFisca](http://www.openfisca.fr/) est un logiciel libre et polyvalent de micro-simulation. Ceci est le code source du module Tunisien d\u00e9di\u00e9 aux pensions.\n\n<p align='right'>\u0627\u0644\u062c\u0628\u0627\u064a\u0629 \u0627\u0644\u0645\u0641\u062a\u0648\u062d\u0629 \u0628\u0631\u0646\u0627\u0645\u062c \u062d\u0631 \u0648 \u0645\u062a\u0639\u062f\u062f \u0627\u0644\u0643\u0641\u0627\u0621\u0627\u062a \u0644\u0645\u062d\u0627\u0643\u0627\u0629 \u0627\u0644\u0646\u0638\u0627\u0645 \u0627\u0644\u062c\u0628\u0627\u0626\u064a. \u0647\u0630\u0627 \u0647\u0648 \u0645\u0635\u062f\u0631 \u0627\u0644\u0628\u0631\u0646\u0627\u0645\u062c \u0644\u0644\u0648\u062d\u062f\u0629 \u0627\u0644\u062a\u0648\u0646\u0633\u064a\u0629 \u0627\u0644\u062e\u0627\u0635\u0629 \u0628\u0627\u0644\u0645\u0646\u062d </p>\n\n[OpenFisca](https://www.openfisca.fr/en) is a versatile microsimulation free software. This is the source code of the Tunisian pension module.\n\n## Contribution & Contact - \u0627\u0644\u0645\u0633\u0627\u0647\u0645\u0629 \u0648\u0627\u0644\u0627\u062a\u0635\u0627\u0644 \u0628\u0646\u0627\n\nOpenFisca est un projet de logiciel libre.\n\nSon code source est distribu\u00e9 sous la licence [GNU Affero General Public Licence](http://www.gnu.org/licenses/agpl.html)\nversion 3 ou ult\u00e9rieure (cf. [LICENSE](https://github.com/openfisca/openfisca-tunisia-pension/blob/master/LICENSE)).\n\nN'h\u00e9sitez pas \u00e0 rejoindre l'\u00e9quipe de d\u00e9veloppement OpenFisca ! Pour en savoir plus, une [documentation](https://doc.openfisca.fr/contribute/index.html) est \u00e0 votre disposition.\n\n\n<p align='right'> \u0627\u0644\u062c\u0628\u0627\u064a\u0629 \u0627\u0644\u0645\u0641\u062a\u0648\u062d\u0629 \u0628\u0631\u0646\u0627\u0645\u062c \u062d\u0631</p>\n\n<p align='right'> \u062a\u0645 \u062a\u0648\u0632\u064a\u0639 \u0645\u0635\u062f\u0631 \u0647\u0630\u0627 \u0627\u0644\u0628\u0631\u0646\u0627\u0645\u062c \u062a\u062d\u062a \u0631\u062e\u0635\u0629 \u0623\u0641\u064a\u0631\u0648 \u0627\u0644\u0639\u0627\u0645\u0629 \u0627\u0644\u062b\u0627\u0644\u062b\u0629 \u0623\u0648 \u0645\u0627 \u0623\u0639\u0644\u0649</p>\n\n<p align='right'>\u062a\u0639\u0627\u0644\u0648 \u0627\u0646\u0636\u0645\u0648 \u0625\u0644\u0649 \u0641\u0631\u064a\u0642 \u0627\u0644\u062c\u0628\u0627\u064a\u0629 \u0627\u0644\u0645\u0641\u062a\u0648\u062d\u0629 \u0648 \u0633\u0627\u0647\u0645\u0648 \u0641\u064a \u062a\u0637\u0648\u064a\u0631 \u0627\u0644\u0628\u0631\u0646\u0627\u0645\u062c!\n\u0627\u0646\u0638\u0631\u0648 \u0644\u0644\u0645\u0648\u0642\u0639 \u0627\u0644\u0631\u0633\u0645\u064a \u0644\u0644\u0645\u0632\u064a\u062f \u0645\u0646 \u0627\u0644\u0645\u0639\u0644\u0648\u0645\u0627\u062a\n</p>\n\n\nOpenFisca is a free software project.\n\nIts source code is distributed under the [GNU Affero General Public Licence](http://www.gnu.org/licenses/agpl.html)\nversion 3 or later (see [LICENSE](https://github.com/openfisca/openfisca-tunisia-pension/blob/master/LICENSE) file).\n\nFeel free to join the OpenFisca development team! See the [documentation](https://doc.openfisca.fr/contribute/index.html) for more information.\n\n## Documentation\n\n* Documentation g\u00e9n\u00e9rale du projet OpenFisca (tous pays confondus) : https://doc.openfisca.fr\n  - Et son [sch\u00e9ma des composants](https://doc.openfisca.fr/#project-components) d'un projet OpenFisca\n* Explorateur de la l\u00e9gislation couverte par OpenFisca-Tunisia : https://legislation.openfisca.tn\n* Wiki OpenFisca-Tunisia Pension : https://github.com/openfisca/openfisca-tunisia-pension/wiki\n\n\n## Installation\n\nSous Unix/macOS/Linux, appliquez les \u00e9tapes qui suivent dans votre Terminal.\n\nSous Windows, installez un \u00e9mulateur de terminal (tel que [ConEmu](https://conemu.github.io)) avant de poursuivre.\n\n### Pr\u00e9-requis : Langage Python & Gestionnaire d'environnement virtuel\n\nCe projet n\u00e9cessite l'installation pr\u00e9alable des \u00e9l\u00e9ments suivants :\n* Le langage [Python 2.7](https://www.python.org/downloads/)\n* Le gestionnaire de paquets [pip](https://pip.pypa.io/en/stable/installing/).\n\nV\u00e9rifiez alors que la version de python appel\u00e9e par d\u00e9faut d\u00e9bute bien par `2.7` :\n\n```\npython --version\n```\n\nEt pour ce qui suit, les droits d'administrateur pourront vous \u00eatre demand\u00e9s selon l'emplacement de l'installation (`sudo` optionnel).\n\nCommencez par installer les \u00e9ventuelles mises \u00e0 jour pour la gestion de paquets python avec :\n\n```\nsudo pip install --upgrade pip wheel\n```\n\nEnsuite, afin de cr\u00e9er un environnement de travail propre et pour vous permettre de faire cohabiter plusieurs contextes de travail en python, nous vous conseillons l'utilisation d'environnements virtuels, dits virtualenv. Il vous faut alors installer un gestionnaire de virtualenv python tel que [pew](https://github.com/berdario/pew) :\n\n```\nsudo pip install pew\n```\n\nIl vous est d\u00e9sormais possible de cr\u00e9er votre premier environnement d\u00e9di\u00e9 \u00e0 OpenFisca-Tunisia Pension.\n\n### Cr\u00e9ation d'environnement virtuel\n\nIl vous sera possible de r\u00e9p\u00e9ter cette \u00e9tape de multiples fois au cours de vos travaux sur vos projets python.\nA chaque fois, vous choisirez un nouveau nom d'environnement.\n\nSoit `pension` le nom que vous auriez choisi pour votre premier environnement virtuel OpenFisca-Tunisia Pension :\n\n```\npew new pension --python=python2.7\n# Si demand\u00e9, r\u00e9pondez \"Y\" \u00e0 la question sur la modification du fichier de configuration de votre shell\n```\n\nUsage :\n* Vous pouvez sortir du virtualenv en tapant exit (ou Ctrl-D)\n* Vous pouvez le r\u00e9activer gr\u00e2ce \u00e0 `pew workon pension`\n\n### Installation du code source\n\nAfin d'interroger ou de modifier OpenFisca-Tunisia Pension, il vous faut installer le code source en local sur votre ordinateur.\n\nNous supposons que vous avez activ\u00e9 votre environnement virtuel et que vous vous situez dans le r\u00e9pertoire o\u00f9 vous souhaitez placer le projet.\n\nAppliquez alors les commandes suivantes pour r\u00e9cup\u00e9rer les sources d'OpenFisca-Tunisia Pension et configurer le projet (sans omettre le point en fin de ligne :slightly_smiling_face:) :\n\n```\ngit clone https://github.com/openfisca/openfisca-tunisia-pension.git\ncd openfisca-tunisia-pension\npip install -e .\n```\n\n:tada: F\u00e9licitations, vous avez d\u00e9sormais termin\u00e9 l'installation d'OpenFisca Tunisia Pension !\n\nVous pouvez v\u00e9rifier que votre environnement fonctionne bien en d\u00e9marrant les tests tel que d\u00e9crit dans le paragraphe suivant.\n\n## Test\n\nNous supposons que vous \u00eates dans le r\u00e9pertoire `openfisca-tunisia-pension` et que votre environnement virtuel est activ\u00e9.\nCommencez par installer les outils de test avec :\n\n```\npip install -e .[tests]\n```\n\n### Test nose\n\nUn test r\u00e9dig\u00e9 en python peut \u00eatre ex\u00e9cut\u00e9 avec l'outil `nose`. Celui-ci d\u00e9roulera les fonctions python dont le nom commence par le mot `test`.\n\nAinsi, pour ex\u00e9cuter le test python `openfisca_tunisia_pension/tests/test_pension.py`, utilisez la commande suivante :\n\n```\nnosetests nosetests openfisca_tunisia_pension/tests/test_pension.py\n```\n\nIl vous est \u00e9galement possible de n'ex\u00e9cuter qu'un seul test d'un fichier. Dans l'exemple suivant, `test_rsna` sera l'unique test d\u00e9roul\u00e9 du fichier `openfisca_tunisia_pension/tests/test_pension.py` :\n\n```\nnosetests openfisca_tunisia_pension/tests/test_pension.py:test_rsna\n```\n\n### Test yaml\n\nLe format d'un test yaml est d\u00e9crit dans la [documentation officielle](https://doc.openfisca.fr/coding-the-legislation/writing_yaml_tests.html).\n\nAinsi, si vous souhaitez ex\u00e9cuter le test yaml `openfisca_tunisia_pension/tests/formulas/pension_rsna.yaml`, utilisez la commande :\n\n```\nopenfisca-run-test -c openfisca_tunisia_pension openfisca_tunisia_pension/tests/formulas/pension_rsna.yaml\n```\n\n### Tout tester\n\nL'ensemble des tests d\u00e9finis dans OpenFisca-Tunisia peut \u00eatre d\u00e9marr\u00e9 gr\u00e2ce \u00e0 la commande suivante :\n\n```\nmake test\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "OpenFisca Rules as Code model for Tunisia pensions.",
    "version": "3.0.0",
    "project_urls": {
        "Changelog": "https://github.com/openfisca/openfisca-tunisia-pension/blob/main/CHANGELOG.md",
        "Documentation": "https://openfisca.org/doc",
        "Homepage": "https://github.com/openfisca/openfisca-tunisia-pension",
        "Issues": "https://github.com/openfisca/openfisca-tunisia-pension/issues",
        "Repository": "https://github.com/openfisca/openfisca-tunisia-pension"
    },
    "split_keywords": [
        "microsimulation",
        " tax",
        " benefit",
        " pension",
        " rac",
        " rules-as-code",
        " tunisia"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "95136a2aa6e281ea6cda78000df5a98d4729a5a793f694bd77453f83ff0f1d3e",
                "md5": "1b821863b4215c6a57e3a921ad8fd85c",
                "sha256": "0999efb102807983301d6700e30a49f8aee23ecaa2d3fc5706156d1bace5e903"
            },
            "downloads": -1,
            "filename": "OpenFisca_Tunisia_Pension-3.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1b821863b4215c6a57e3a921ad8fd85c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 99518,
            "upload_time": "2024-11-15T11:41:50",
            "upload_time_iso_8601": "2024-11-15T11:41:50.426377Z",
            "url": "https://files.pythonhosted.org/packages/95/13/6a2aa6e281ea6cda78000df5a98d4729a5a793f694bd77453f83ff0f1d3e/OpenFisca_Tunisia_Pension-3.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "27c96e0f799caa81a62d51ca710f84d21021b9a91838a5f3d26917f335519d53",
                "md5": "a5ac9336ef7bfa6fa04bdaf5f65a83dd",
                "sha256": "1888b720dc5ee02a1e4d680d396b938dd870e3c7ca1d9e2319ee9c2476f65bf4"
            },
            "downloads": -1,
            "filename": "openfisca_tunisia_pension-3.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a5ac9336ef7bfa6fa04bdaf5f65a83dd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 103138,
            "upload_time": "2024-11-15T11:41:52",
            "upload_time_iso_8601": "2024-11-15T11:41:52.134652Z",
            "url": "https://files.pythonhosted.org/packages/27/c9/6e0f799caa81a62d51ca710f84d21021b9a91838a5f3d26917f335519d53/openfisca_tunisia_pension-3.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-15 11:41:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "openfisca",
    "github_project": "openfisca-tunisia-pension",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "openfisca-tunisia-pension"
}
None
Elapsed time: 0.91038s