InseeFrLab / InseeFrLab/pynsee

Move OSM and personal data warnings

Open
#147 3 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Python
Stars
89
Forks
14
PR merge metrics
No merged PRs in 30d

Description

At the moment, the [``_warning_OSM``](https://github.com/InseeFrLab/pynsee/blob/c630e221ee4205e8df213ed8f6c1fb73fe96dc78/pynsee/sirene/get_location.py#L24) and [``_warning_search_sirene``](https://github.com/InseeFrLab/pynsee/blob/c630e221ee4205e8df213ed8f6c1fb73fe96dc78/pynsee/sirene/search_sirene.py#L18) functions are used to display warnings about legal implications.

This is probably not the best way to warn users and we should discuss how to handle it (probably in the docstrings and possibly also somewhere else in the README and/or the documentation).

EDIT: regarding SIRENE, it was decided to keep the warning in the code; for OSM, "info" logging level was used so it would be good to add the license information in the documentation and docstrings

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.