# Présentation du module
**apifoncier** est un module Python qui propose
une boîte à outils pour interagir plus facilement avec [l'API
Données foncières du Cerema](https://apidf-preprod.cerema.fr/).
Il permet d'interroger facilement les différentes bases de données
foncières produites par le Cerema et la DGALN directement en Python.
# Installation
``` python
pip install apifoncier
```
# Documentation du module
La documentation complète est accessible au lien suivant : [https://rcadot.github.io/py.apifoncier/](https://rcadot.github.io/py.apifoncier/)
Des exemples sous forme de notebook sont également proposées.
# Quickstart
Quelques exemples pour démarrer :
```python
## Récupérer des données de consommation d'espace sur une commune
import apifoncier.ind_conso_espace as conso
df = conso.communes(code_insee='59350')
```
```python
## Récupérer des données de prix sur une commune
import apifoncier.ind_prix as prix
df = prix.communes(code_insee='59350')
```
```python
## Récupérer des transactions issues de DVF+ sur une commune
import apifoncier.dvf_opendata as dvf
df = dvf.mutations(code_insee='59350')
# avec les geometries
gdf = dvf.geomutations(in_bbox=[3, 50, 3.01, 50.01])
```
# Ressources
Pour retrouver toutes les informations sur les données foncières :
[datafoncier.cerema.fr](https://datafoncier.cerema.fr)
Dictionnaire et documentation sur toutes les variables :
[doc-datafoncier.cerema.fr](http://doc-datafoncier.cerema.fr)
[Pour en savoir plus sur l’API données foncières du
cerema.](https://apidf-preprod.cerema.fr/swagger/)
Raw data
{
"_id": null,
"home_page": "https://github.com/rcadot/py.apifoncier",
"name": "apifoncier",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "api, foncier, cerema, dv3f, friches, artificialisation",
"author": "Romain Cadot",
"author_email": "romain.cadot@cerema.fr",
"download_url": "https://files.pythonhosted.org/packages/fa/f2/dface8275d14bf5700d27c5f828eb0af435ff8118e08c46e5eda1650cb56/apifoncier-0.0.27.tar.gz",
"platform": null,
"description": "\r\n# Pr\u00e9sentation du module\r\n\r\n**apifoncier** est un module Python qui propose \r\nune bo\u00eete \u00e0 outils pour interagir plus facilement avec [l'API\r\nDonn\u00e9es fonci\u00e8res du Cerema](https://apidf-preprod.cerema.fr/).\r\n\r\nIl permet d'interroger facilement les diff\u00e9rentes bases de donn\u00e9es \r\nfonci\u00e8res produites par le Cerema et la DGALN directement en Python. \r\n\r\n# Installation\r\n\r\n``` python\r\npip install apifoncier\r\n```\r\n\r\n# Documentation du module\r\n\r\nLa documentation compl\u00e8te est accessible au lien suivant : [https://rcadot.github.io/py.apifoncier/](https://rcadot.github.io/py.apifoncier/)\r\n\r\nDes exemples sous forme de notebook sont \u00e9galement propos\u00e9es.\r\n\r\n# Quickstart\r\n\r\nQuelques exemples pour d\u00e9marrer :\r\n\r\n```python\r\n## R\u00e9cup\u00e9rer des donn\u00e9es de consommation d'espace sur une commune\r\nimport apifoncier.ind_conso_espace as conso\r\n\r\ndf = conso.communes(code_insee='59350')\r\n```\r\n\r\n```python\r\n## R\u00e9cup\u00e9rer des donn\u00e9es de prix sur une commune\r\nimport apifoncier.ind_prix as prix\r\n\r\ndf = prix.communes(code_insee='59350')\r\n```\r\n\r\n\r\n```python\r\n## R\u00e9cup\u00e9rer des transactions issues de DVF+ sur une commune\r\nimport apifoncier.dvf_opendata as dvf\r\n\r\ndf = dvf.mutations(code_insee='59350')\r\n# avec les geometries\r\ngdf = dvf.geomutations(in_bbox=[3, 50, 3.01, 50.01])\r\n```\r\n\r\n# Ressources\r\n\r\nPour retrouver toutes les informations sur les donn\u00e9es fonci\u00e8res :\r\n[datafoncier.cerema.fr](https://datafoncier.cerema.fr)\r\n\r\nDictionnaire et documentation sur toutes les variables :\r\n[doc-datafoncier.cerema.fr](http://doc-datafoncier.cerema.fr)\r\n\r\n[Pour en savoir plus sur l\u2019API donn\u00e9es fonci\u00e8res du\r\ncerema.](https://apidf-preprod.cerema.fr/swagger/)\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Mobiliser les donn\u00e9es fonci\u00e8res de l'api du Cerema directement avec python",
"version": "0.0.27",
"project_urls": {
"Homepage": "https://github.com/rcadot/py.apifoncier"
},
"split_keywords": [
"api",
" foncier",
" cerema",
" dv3f",
" friches",
" artificialisation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "429bda5830a079bc7610c4d798abfbb1b5671c35bf9bfbfc052b4c37d8eac72f",
"md5": "e895011501c3537e6768be554a80d35d",
"sha256": "744bd314a708239e0aed59852b2d3bdddb9f954414a51ae1b90f175bf035170d"
},
"downloads": -1,
"filename": "apifoncier-0.0.27-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e895011501c3537e6768be554a80d35d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 15623,
"upload_time": "2024-06-25T19:58:50",
"upload_time_iso_8601": "2024-06-25T19:58:50.751930Z",
"url": "https://files.pythonhosted.org/packages/42/9b/da5830a079bc7610c4d798abfbb1b5671c35bf9bfbfc052b4c37d8eac72f/apifoncier-0.0.27-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "faf2dface8275d14bf5700d27c5f828eb0af435ff8118e08c46e5eda1650cb56",
"md5": "6753dd43c3cf2031f409d1028e340b44",
"sha256": "045ba9b4c72bc7a8422ae6828d8526ac3ba6dea6791d7df8b50fcafbbd0df0b2"
},
"downloads": -1,
"filename": "apifoncier-0.0.27.tar.gz",
"has_sig": false,
"md5_digest": "6753dd43c3cf2031f409d1028e340b44",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 11374,
"upload_time": "2024-06-25T19:58:52",
"upload_time_iso_8601": "2024-06-25T19:58:52.578212Z",
"url": "https://files.pythonhosted.org/packages/fa/f2/dface8275d14bf5700d27c5f828eb0af435ff8118e08c46e5eda1650cb56/apifoncier-0.0.27.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-25 19:58:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rcadot",
"github_project": "py.apifoncier",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "geopandas",
"specs": []
},
{
"name": "tqdm",
"specs": []
}
],
"lcname": "apifoncier"
}
JSON
