the-datagarden-models 3.0.0

Base data models for the datagarden.

The-datagarden-models package is supporting package for the-datagarden api (see The DataGarden Website) and the-datagarden package (see the-datagarden package). 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.

Version 2.0.0 introduces the V2 model family (DemographicsV2, EconomicsV2, TradeV2, …): every quantified value is a Measure (amount × unit, explicit currency and price basis), scalar types are bounded, and key namespaces are generated from the models themselves. The V1 family stays importable and frozen for one major cycle (a DeprecationWarning is emitted on import); stored documents resolve to the right family via resolve_model(name, version). See CHANGELOG.md.

A quick example

If you have a user account at the-datagarden.io, you can start using the SDK right away:

# Retrieve a country object from the datagarden API
>>> from the-datagarden import TheDataGardenAPI
>>> the_datagarden_api = TheDataGardenAPI(email='[e-mail]', 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

• API Documentation

• Documentation on the Datagarden Models

• GitHub Repository for 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.