vacances-scolaires-france


Namevacances-scolaires-france JSON
Version 0.10.0 PyPI version JSON
download
home_pagehttps://github.com/AntoineAugusti/vacances-scolaires-france
SummaryGet school holiday dates for metropolitan France
upload_time2023-02-05 16:26:46
maintainer
docs_urlNone
authorAntoine Augusti
requires_python>=2.7, <4
licenseMIT
keywords vacances scolaires calendrier france school holiday calendar
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/AntoineAugusti/vacances-scolaires-france/blob/master/LICENSE.md)
![CircleCI](https://img.shields.io/circleci/project/github/AntoineAugusti/vacances-scolaires-france.svg?style=flat-square)
![PyPI - Downloads](https://img.shields.io/pypi/dm/vacances-scolaires-france.svg?style=flat-square)

# Vacances scolaires France
This package can be used to find the dates of school holidays in France, since 1990.

In French in the text: cette librairie permet de connaître les dates des vacances scolaires en France, depuis 1990, pour les zones A, B et C.

La répartition en trois zones de vacances A, B et C est définie de la façon suivante.

**Septembre 1995 - Janvier 2016** :
- Zone A : Académies de Caen, Clermont-Ferrand, Grenoble, Lyon, Montpellier, Nancy-Metz, Nantes, Rennes, Toulouse
- Zone B : Académies d'Aix-Marseille, Amiens, Besançon, Dijon, Lille, Limoges, Nice, Orléans-Tours, Poitiers, Reims, Rouen , Strasbourg,
- Zone C : Académies de Bordeaux, Créteil, Paris, Versailles

**Depuis janvier 2016** :
- Zone A : Académies de Besançon, Bordeaux, Clermont-Ferrand, Dijon, Grenoble, Limoges, Lyon, Poitiers
- Zone B : Académies d'Aix-Marseille, Amiens, Caen, Lille, Nantes, Nice, Nancy-Metz, Orléans-Tours, Reims, Rennes, Rouen, Strasbourg
- Zone C : Académies de Créteil, Montpellier, Paris, Versailles, Toulouse

## Installation
```
pip install vacances-scolaires-france
```

## Usage

```python
from vacances_scolaires_france import SchoolHolidayDates

import datetime

d = SchoolHolidayDates()
# Is it an holiday for zone A, B or C?
d.is_holiday(datetime.date(2017, 12, 25))
# Returns: True

# Is it an holiday for a given zone?
d.is_holiday_for_zone(datetime.date(2009, 2, 7), 'A')
# Returns: True

# Get holidays for any zone in a year
d.holidays_for_year(2018)
# Returns: {datetime.date(2018, 1, 1): OrderedDict([('date', datetime.date(2018, 01, 01)), ('vacances_zone_a', True), ('vacances_zone_b', True), ('vacances_zone_c', True), ('nom_vacances', 'Vacances de Noël')]), ...}

# Get holiday dates given a year and an holiday name
d.holiday_for_year_by_name(2017, 'Vacances de la Toussaint')
# Returns: {datetime.date(2017, 10, 21): OrderedDict([('date', datetime.date(2017, 10, 21)), ('vacances_zone_a', True), ('vacances_zone_b', True), ('vacances_zone_c', True), ...}

# Get holiday dates for a given year and zone
d.holidays_for_year_and_zone(2017, 'A')
# Returns: {datetime.date(2017, 1, 1): OrderedDict([('date', datetime.date(2017, 01, 01)), ('vacances_zone_a', True), ('vacances_zone_b', True), ('vacances_zone_c', True), ...}

# Get holiday dates for a given year, zone and holiday name
d.holidays_for_year_zone_and_name(2017, 'A', 'Vacances de Noël')
# Returns: {datetime.date(2017, 1, 1): OrderedDict([('date', datetime.date(2017, 1, 1)), ('vacances_zone_a', True), ('vacances_zone_b', True), ('vacances_zone_c', True), ('nom_vacances', 'Vacances de Noël')]), ...}
```

## Zone names
Use the capital letters A, B or C.

## Holiday names
You can use the following holiday names:
- Vacances de Noël
- Vacances d'hiver
- Vacances de printemps
- Vacances d'été
- Vacances de la Toussaint
- Pont de l'Ascension (only for some years)

## Data
School holiday dates are coming from the ["Vacances scolaires par zones" opendata dataset](https://www.data.gouv.fr/fr/datasets/vacances-scolaires-par-zones/) available on data.gouv.fr.

## Bank holidays
Interested in bank holidays as well (jours fériés in French)? There is another pip package for this! Check out https://github.com/AntoineAugusti/jours-feries-france

## Notice
This software is available under the MIT license and was developed as part of the [Entrepreneur d'Intérêt Général program](https://entrepreneur-interet-general.etalab.gouv.fr) by the French government.

Projet développé dans le cadre du programme « [Entrepreneur d’intérêt général](https://entrepreneur-interet-general.etalab.gouv.fr) ».



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/AntoineAugusti/vacances-scolaires-france",
    "name": "vacances-scolaires-france",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=2.7, <4",
    "maintainer_email": "",
    "keywords": "vacances,scolaires,calendrier,france,school,holiday,calendar",
    "author": "Antoine Augusti",
    "author_email": "hi@antoine-augusti.fr",
    "download_url": "",
    "platform": null,
    "description": "[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/AntoineAugusti/vacances-scolaires-france/blob/master/LICENSE.md)\n![CircleCI](https://img.shields.io/circleci/project/github/AntoineAugusti/vacances-scolaires-france.svg?style=flat-square)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/vacances-scolaires-france.svg?style=flat-square)\n\n# Vacances scolaires France\nThis package can be used to find the dates of school holidays in France, since 1990.\n\nIn French in the text: cette librairie permet de conna\u00eetre les dates des vacances scolaires en France, depuis 1990, pour les zones A, B et C.\n\nLa r\u00e9partition en trois zones de vacances A, B et C est d\u00e9finie de la fa\u00e7on suivante.\n\n**Septembre 1995 - Janvier 2016** :\n- Zone A : Acad\u00e9mies de Caen, Clermont-Ferrand, Grenoble, Lyon, Montpellier, Nancy-Metz, Nantes, Rennes, Toulouse\n- Zone B : Acad\u00e9mies d'Aix-Marseille, Amiens, Besan\u00e7on, Dijon, Lille, Limoges, Nice, Orl\u00e9ans-Tours, Poitiers, Reims, Rouen , Strasbourg,\n- Zone C : Acad\u00e9mies de Bordeaux, Cr\u00e9teil, Paris, Versailles\n\n**Depuis janvier 2016** :\n- Zone A : Acad\u00e9mies de Besan\u00e7on, Bordeaux, Clermont-Ferrand, Dijon, Grenoble, Limoges, Lyon, Poitiers\n- Zone B : Acad\u00e9mies d'Aix-Marseille, Amiens, Caen, Lille, Nantes, Nice, Nancy-Metz, Orl\u00e9ans-Tours, Reims, Rennes, Rouen, Strasbourg\n- Zone C : Acad\u00e9mies de Cr\u00e9teil, Montpellier, Paris, Versailles, Toulouse\n\n## Installation\n```\npip install vacances-scolaires-france\n```\n\n## Usage\n\n```python\nfrom vacances_scolaires_france import SchoolHolidayDates\n\nimport datetime\n\nd = SchoolHolidayDates()\n# Is it an holiday for zone A, B or C?\nd.is_holiday(datetime.date(2017, 12, 25))\n# Returns: True\n\n# Is it an holiday for a given zone?\nd.is_holiday_for_zone(datetime.date(2009, 2, 7), 'A')\n# Returns: True\n\n# Get holidays for any zone in a year\nd.holidays_for_year(2018)\n# Returns: {datetime.date(2018, 1, 1): OrderedDict([('date', datetime.date(2018, 01, 01)), ('vacances_zone_a', True), ('vacances_zone_b', True), ('vacances_zone_c', True), ('nom_vacances', 'Vacances de No\u00ebl')]), ...}\n\n# Get holiday dates given a year and an holiday name\nd.holiday_for_year_by_name(2017, 'Vacances de la Toussaint')\n# Returns: {datetime.date(2017, 10, 21): OrderedDict([('date', datetime.date(2017, 10, 21)), ('vacances_zone_a', True), ('vacances_zone_b', True), ('vacances_zone_c', True), ...}\n\n# Get holiday dates for a given year and zone\nd.holidays_for_year_and_zone(2017, 'A')\n# Returns: {datetime.date(2017, 1, 1): OrderedDict([('date', datetime.date(2017, 01, 01)), ('vacances_zone_a', True), ('vacances_zone_b', True), ('vacances_zone_c', True), ...}\n\n# Get holiday dates for a given year, zone and holiday name\nd.holidays_for_year_zone_and_name(2017, 'A', 'Vacances de No\u00ebl')\n# Returns: {datetime.date(2017, 1, 1): OrderedDict([('date', datetime.date(2017, 1, 1)), ('vacances_zone_a', True), ('vacances_zone_b', True), ('vacances_zone_c', True), ('nom_vacances', 'Vacances de No\u00ebl')]), ...}\n```\n\n## Zone names\nUse the capital letters A, B or C.\n\n## Holiday names\nYou can use the following holiday names:\n- Vacances de No\u00ebl\n- Vacances d'hiver\n- Vacances de printemps\n- Vacances d'\u00e9t\u00e9\n- Vacances de la Toussaint\n- Pont de l'Ascension (only for some years)\n\n## Data\nSchool holiday dates are coming from the [\"Vacances scolaires par zones\" opendata dataset](https://www.data.gouv.fr/fr/datasets/vacances-scolaires-par-zones/) available on data.gouv.fr.\n\n## Bank holidays\nInterested in bank holidays as well (jours f\u00e9ri\u00e9s in French)? There is another pip package for this! Check out https://github.com/AntoineAugusti/jours-feries-france\n\n## Notice\nThis software is available under the MIT license and was developed as part of the [Entrepreneur d'Int\u00e9r\u00eat G\u00e9n\u00e9ral program](https://entrepreneur-interet-general.etalab.gouv.fr) by the French government.\n\nProjet d\u00e9velopp\u00e9 dans le cadre du programme \u00ab [Entrepreneur d\u2019int\u00e9r\u00eat g\u00e9n\u00e9ral](https://entrepreneur-interet-general.etalab.gouv.fr) \u00bb.\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Get school holiday dates for metropolitan France",
    "version": "0.10.0",
    "split_keywords": [
        "vacances",
        "scolaires",
        "calendrier",
        "france",
        "school",
        "holiday",
        "calendar"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a0b012dea8a4dd5d78707d3f52bed0fb9dc0728c918247cf579ed3b3e0908bc5",
                "md5": "77fdf3714103a6a059c07bcf73d36820",
                "sha256": "9f8a107c6a350b33913bca2ab6e8b04f189699eabf809fed5feccb6f8edb4c9c"
            },
            "downloads": -1,
            "filename": "vacances_scolaires_france-0.10.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "77fdf3714103a6a059c07bcf73d36820",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=2.7, <4",
            "size": 47206,
            "upload_time": "2023-02-05T16:26:46",
            "upload_time_iso_8601": "2023-02-05T16:26:46.942542Z",
            "url": "https://files.pythonhosted.org/packages/a0/b0/12dea8a4dd5d78707d3f52bed0fb9dc0728c918247cf579ed3b3e0908bc5/vacances_scolaires_france-0.10.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-02-05 16:26:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "AntoineAugusti",
    "github_project": "vacances-scolaires-france",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "circle": true,
    "lcname": "vacances-scolaires-france"
}
        
Elapsed time: 0.04712s