InseeFrLab / cartiflette

Projet visant à simplifier la récupération des shapefiles officiels
https://inseefrlab.github.io/cartiflette-website/
MIT License
49 stars 7 forks source link

Incohérence arguments Readme #63

Closed Palomia closed 1 year ago

Palomia commented 1 year ago

Bonjour, je suis débutant en python et surtout dans l'utilisation de package GIT. Il est donc plus que probable que l'erreur vienne de moi. Je ne trouve cependant pas où je me trompe.

Le READme propose la requête test suivante :

import cartiflette.s3

normandie = cartiflette.s3.download_vectorfile_url_all(
    values = "11",
    level="COMMUNE",
    vectorfile_format="geojson",
    decoupage="region",
    year=2022)
ax = normandie.plot()
ax.set_axis_off()

Cependant help(cartiflette.s3.download_vectorfile_url_all) renvoie :

Help on function download_vectorfile_url_all in module cartiflette.s3.s3:

download_vectorfile_url_all(values: Union[str, int, float] = '28', borders='COMMUNE', vectorfile_format='geojson', filter_by='region', year=2022, provider: str = 'IGN', source: str = 'EXPRESS-COG-TERRITOIRE', crs=None)

Les arguments level et decoupage ne semblent donc pas présents dans la fonction.

linogaliana commented 1 year ago

Bonjour @Palomia ! Merci pour ce retour !

Le problème vient du fait que les changements récents dans les noms d'arguments (visant à les rendre plus clairs) n'ont pas été mis dans le README (normalement ils sont ok dans la documentation interactive qu'on a commencé à faire ici), désolé de l'oubli.

Je m'en occupe de suite !

linogaliana commented 1 year ago

@Palomia je viens de corriger le README (6b26cb5f28ac61c948e7b219c91bf184ed8e3c5b) pour mettre à jour les arguments:

import cartiflette.s3

normandie = cartiflette.s3.download_vectorfile_url_all(
    crs = 4326,
    values = "11",
    borders="COMMUNE",
    vectorfile_format="topojson",
    filter_by="REGION",
    source="EXPRESS-COG-CARTO-TERRITOIRE",
    year=2022)
ax = normandie.plot()
ax.set_axis_off()

On est en train de restructurer le package pour rendre la mise à disposition des fonds de carte moins artisanale. Tous les retours sont les bienvenus ! 😺