=====================
the-datagarden-models
=====================
The-datagarden-models package is supporting package for the-datagarden api (see `The DataGarden Website <https://www.the-datagarden.io>`_) and
the-datagarden package (see `the-datagarden package <https://pypi.org/project/the-datagarden/>`_). The-datagarden api and package
are developed to give data professionals easy access to regional data from public sources without having to understand the sources, api's and data formats
from those public data sources.
The-datagarden-models package contains the Pydantic models for the data returned by the-datagarden api and can be used to work with the data
returned by the api in a more pythonic way than only using the json.
A quick example
---------------
If you have a user account at the-datagarden.io, you can start using the SDK right away:
.. code-block:: python
# Retrieve a country object from the datagarden API
>>> from the-datagarden import TheDataGardenAPI
>>> the_datagarden_api = TheDataGardenAPI(email='your-email@example.com', password='your-password')
>>> nl = the_datagarden_api.netherlands()
>>> nl_demographics = nl.demographics(from_period="2010-01-01", source="united nations")
>>> nl_demographics
TheDataGardenRegionalDataModel : Demographics : (count=15)
this returns a `TheDataGardenRegionalDataModel` containimg the demographics data in this case 15 records.
Each of those records will contain a Demographics object for the region for the specified period.
Read more
---------
* `The DataGarden Website <https://www.the-datagarden.io>`_
* `API Documentation <https://www.the-datagarden.io/api-docs>`_
* `Documentation on the Datagarden Models <https://www.the-datagarden.io/data-docs>`_
* `GitHub Repository for the-datagarden-models <https://github.com/MaartendeRuyter/dg-the-datagarden-models>`_
Access to The DataGarden API
----------------------------
To use the DataGarden SDK, you need access to the The DataGarden API. Simply register for free at https://www.the-datagarden.io
and you will have an inital free access account to the API with access to country and continent data.
Visit https://www.the-datagarden.io for to register for free.
Raw data
{
"_id": null,
"home_page": null,
"name": "the-datagarden-models",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "geojson, demographics, economics",
"author": null,
"author_email": "Maarten de Ruyter <info@the-datagarden.io>",
"download_url": "https://files.pythonhosted.org/packages/b8/9a/ed2427a6daecf8cab4842d97f45736433ff1cb0ffc52deb110aa3382f3c4/the_datagarden_models-1.7.6.tar.gz",
"platform": null,
"description": "=====================\nthe-datagarden-models\n=====================\n\nThe-datagarden-models package is supporting package for the-datagarden api (see `The DataGarden Website <https://www.the-datagarden.io>`_) and\nthe-datagarden package (see `the-datagarden package <https://pypi.org/project/the-datagarden/>`_). The-datagarden api and package\nare developed to give data professionals easy access to regional data from public sources without having to understand the sources, api's and data formats\nfrom those public data sources.\n\nThe-datagarden-models package contains the Pydantic models for the data returned by the-datagarden api and can be used to work with the data\nreturned by the api in a more pythonic way than only using the json.\n\nA quick example\n---------------\nIf you have a user account at the-datagarden.io, you can start using the SDK right away:\n\n.. code-block:: python\n\n # Retrieve a country object from the datagarden API\n >>> from the-datagarden import TheDataGardenAPI\n >>> the_datagarden_api = TheDataGardenAPI(email='your-email@example.com', password='your-password')\n >>> nl = the_datagarden_api.netherlands()\n >>> nl_demographics = nl.demographics(from_period=\"2010-01-01\", source=\"united nations\")\n >>> nl_demographics\n TheDataGardenRegionalDataModel : Demographics : (count=15)\n\nthis returns a `TheDataGardenRegionalDataModel` containimg the demographics data in this case 15 records.\nEach of those records will contain a Demographics object for the region for the specified period.\n\n\nRead more\n---------\n\n* `The DataGarden Website <https://www.the-datagarden.io>`_\n* `API Documentation <https://www.the-datagarden.io/api-docs>`_\n* `Documentation on the Datagarden Models <https://www.the-datagarden.io/data-docs>`_\n* `GitHub Repository for the-datagarden-models <https://github.com/MaartendeRuyter/dg-the-datagarden-models>`_\n\nAccess to The DataGarden API\n----------------------------\nTo use the DataGarden SDK, you need access to the The DataGarden API. Simply register for free at https://www.the-datagarden.io\nand you will have an inital free access account to the API with access to country and continent data.\n\nVisit https://www.the-datagarden.io for to register for free.\n",
"bugtrack_url": null,
"license": null,
"summary": "Base data models for the datagarden.",
"version": "1.7.6",
"project_urls": {
"Data Models": "https://www.the-datagarden.io/data-docs",
"Read the Docs": "https://dg-the-datagarden-models.readthedocs.io/en/latest/",
"Source": "https://github.com/OlivettaDataGarden/dg-the-datagarden-models",
"The-DataGarden": "https://www.the-datagarden.io/"
},
"split_keywords": [
"geojson",
" demographics",
" economics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9dc1c5788cf098ee3e8939dcf2e6463588a6c523783e0575a358534197d7a9b3",
"md5": "88ba15e252c3e9d7d4ec4477f56eb627",
"sha256": "f2d5dbd9a99ca8a9f545a44d85d555dcd445731766d86bb01d7064058a4be4ed"
},
"downloads": -1,
"filename": "the_datagarden_models-1.7.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "88ba15e252c3e9d7d4ec4477f56eb627",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 45164,
"upload_time": "2025-01-06T12:21:29",
"upload_time_iso_8601": "2025-01-06T12:21:29.741196Z",
"url": "https://files.pythonhosted.org/packages/9d/c1/c5788cf098ee3e8939dcf2e6463588a6c523783e0575a358534197d7a9b3/the_datagarden_models-1.7.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b89aed2427a6daecf8cab4842d97f45736433ff1cb0ffc52deb110aa3382f3c4",
"md5": "f293315efcad2c36814917a3f207e0db",
"sha256": "164cadff3cd88b729368904a7f6e877cbe5436932bf17bbd4407f04824a63dfd"
},
"downloads": -1,
"filename": "the_datagarden_models-1.7.6.tar.gz",
"has_sig": false,
"md5_digest": "f293315efcad2c36814917a3f207e0db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 28409,
"upload_time": "2025-01-06T12:21:32",
"upload_time_iso_8601": "2025-01-06T12:21:32.176670Z",
"url": "https://files.pythonhosted.org/packages/b8/9a/ed2427a6daecf8cab4842d97f45736433ff1cb0ffc52deb110aa3382f3c4/the_datagarden_models-1.7.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-06 12:21:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OlivettaDataGarden",
"github_project": "dg-the-datagarden-models",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "the-datagarden-models"
}
JSON
