the-datagarden-models 0.0.1__tar.gz

the_datagarden_models-0.0.1/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.1
+Name: the-datagarden-models
+Version: 0.0.1
+Summary: Base data models for the datagarden
+Author: Maarten de Ruyter
+Author-email: "Maarten de Ruyter" <maarten@geodatagarden.com>
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Requires-Dist: pydantic

the_datagarden_models-0.0.1/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

the_datagarden_models-0.0.1/setup.cfg

@@ -0,0 +1,106 @@
+[metadata]
+name = the-datagarden-models
+version = 0.0.1
+author = Maarten de Ruyter
+author_email = "Maarten de Ruyter" <maarten@geodatagarden.com>
+license = MIT
+license_files = LICENSE
+classifiers = 
+	License :: OSI Approved :: MIT License
+description = Base data models for the datagarden
+long_description = file: README.rst, CHANGELOG.rst
+
+[options]
+package_dir = 
+	=src
+packages = find:
+install_requires = 
+	pydantic
+include_package_data = True
+
+[options.packages.find]
+where = src
+exclude = 
+	tests*
+
+[mypy]
+python_version = 3.12
+warn_unused_configs = True
+show_error_context = True
+pretty = True
+namespace_packages = True
+check_untyped_defs = True
+
+[flake8]
+max-line-length = 88
+
+[tool:pytest]
+testpaths = tests
+addopts = --cov --strict-markers
+xfail_strict = True
+
+[coverage:run]
+source = record_convertor
+branch = True
+
+[coverage:report]
+show_missing = True
+skip_covered = True
+
+[coverage:paths]
+source = 
+	src/datagarden_models
+	*/site-packages/datagarden_models
+
+[tox:tox]
+envlist = py310, py311, py312
+isolated_build = True
+
+[testenv]
+deps = 
+	pytest
+	pytest-cov
+	pydantic
+commands = 
+	pytest {posargs}
+
+[testenv:typecheck]
+deps = 
+	mypy
+	pytest
+	types-PyYAML
+commands = 
+	mypy --ignore-missing-imports {posargs:src}
+
+[testenv:format]
+skip_install = True
+deps = 
+	ruff>=0.4.3
+	isort>=5.13
+commands = 
+	ruff check --select I --fix
+	ruff format src
+
+[testenv:lint]
+skip_install = True
+deps = 
+	flake8==7.0.0
+	flake8-bugbear==24.4.26
+commands = 
+	flake8 {posargs:src tests}
+
+[testenv:docs]
+skip_install = True
+deps = 
+	sphinx
+	sphinx-rtd-theme
+	mongoengine
+	error-manager
+allowlist_externals = sphinx-build
+commands = 
+	sphinx-build -n -W --keep-going -b html docs/ docs/_build/
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

the_datagarden_models-0.0.1/src/datagarden_models/__init__.py

@@ -0,0 +1,52 @@
+"""
+Module to provide a combined storage and data classes for specified data models.
+The classes include pydantic validation of the data and storage of the data via
+a selected storage class.
+
+
+Available methods
+'init_database'
+    - method to define name and alias for the database
+    - if needed host info and credentials can be added to the arguments
+
+>>> configure_database(host="localhost", port=27017, username="user", password="pass")
+
+
+available Dataclasses
+- GeoNameDataClass, data class aimed at storing data from GeoNames website
+- RetailLocationsDataClass, data class aimed at storing retail locations
+
+avaialble fieldtypes (to be used to instantiatie specific dataclasses fields)
+- PointField
+
+
+Objects for discovery of available dataclasses
+- ALL_MODEL_CLASSES: List with all data models
+- ALL_GDG_MODEL_NAMES: List with class_names of all dataclasses.
+- model_name_to_model: method to retrieve the actual data class for its name.
+"""
+
+from .models.base import DataGardenModel
+
+from .models import DemographicsV1, DemographicsV1Keys
+
+
+class DatagardenDataModels:
+	DEMOGRAPHICS: type[DataGardenModel] = DemographicsV1
+
+
+class DatagardenDataModelKeys:
+	DEMOGRAPHICS: type = DemographicsV1Keys
+
+
+def get_values_from_class(cls: type):
+	for key, value in vars(cls).items():
+		if not key.startswith("__"):
+			yield value
+
+
+AVAILABLE_MODELS = [
+	klass.DATAGARDEN_MODEL_NAME
+	for klass in get_values_from_class(DatagardenDataModelKeys)
+]
+__all__ = ["DatagardenDataModels", "DatagardenDataModelKeys", "AVAILABLE_MODELS"]

the_datagarden_models-0.0.1/src/datagarden_models/models/__init__.py

@@ -0,0 +1,9 @@
+from .base import DataGardenModel
+from .demographics import DemographicsV1, DemographicsV1Keys
+
+
+class DefaultAppModels:
+	DEMOGRAPHICS: type[DataGardenModel] = DemographicsV1
+
+
+__all__ = ["DemographicsV1Keys", "DemographicsV1", "DefaultAppModels"]

the_datagarden_models-0.0.1/src/datagarden_models/models/base.py

@@ -0,0 +1,63 @@
+from typing import Union, get_args, get_origin
+
+from pydantic import BaseModel, Field, model_validator
+
+
+class DataGardenModel(BaseModel):
+	datagarden_model_version: str = Field("v1.0", frozen=True)
+
+	@model_validator(mode="before")
+	def check_datagarden_model_version(cls, values):
+		if (
+			"datagarden_model_version" in values
+			and values["datagarden_model_version"]
+			!= cls.model_fields["datagarden_model_version"].default
+		):
+			raise ValueError("The field 'datagarden_model_version' is immutable.")
+		return values
+
+	@classmethod
+	def units(cls, attribute: str | None = None, indent: int = 0):
+		def print_description(prefix, field_info, indent_level):
+			indent_space = "    " * indent_level
+			description = field_info.description
+			if description:
+				print(f"{indent_space}{prefix}: {description}")
+
+		def is_base_model(annotation):
+			if isinstance(annotation, type) and issubclass(annotation, BaseModel):
+				return True
+			if get_origin(annotation) is Union:
+				return any(is_base_model(arg) for arg in get_args(annotation))
+			return False
+
+		def recursive_units(sub_cls: type[BaseModel], attr_prefix="", indent_level=0):
+			for field_name, field_info in sub_cls.model_fields.items():
+				full_attr_name = (
+					f"{attr_prefix}.{field_name}" if attr_prefix else field_name
+				)
+				if is_base_model(field_info.annotation):
+					print_description(full_attr_name, field_info, indent_level)
+					if field_info.annotation:
+						recursive_units(
+							field_info.annotation, full_attr_name, indent_level + 1
+						)
+					else:
+						print_description(full_attr_name, field_info, indent_level)
+
+		if attribute:
+			parts = attribute.split(".")
+			current_model = cls
+			for part in parts:
+				field_info = current_model.model_fields.get(part)
+				if not field_info:
+					print(f"No description available for attribute: {attribute}")
+					return
+				if issubclass(field_info.__class__, BaseModel):
+					current_model = field_info.__class__
+				else:
+					print_description(attribute, field_info, indent)
+					return
+			recursive_units(current_model, attribute, indent + 1)
+		else:
+			recursive_units(cls)

the_datagarden_models-0.0.1/src/datagarden_models/models/demographics/__init__.py

@@ -0,0 +1,48 @@
+from pydantic import Field
+
+from ..base import DataGardenModel
+from .base_demographics import DemographicsBaseKeys
+from .fertility import Fertility, FertilityV1Keys
+from .life_expectancy import LifeExpectancy, LifeExpectancyV1Keys
+from .mortality import Mortality, MortalityV1Keys
+from .population import Population, PopulationV1Keys
+
+
+class DemographicsV1Keys(
+	PopulationV1Keys,
+	FertilityV1Keys,
+	LifeExpectancyV1Keys,
+	MortalityV1Keys,
+	DemographicsBaseKeys,
+):
+	POPULATION = "population"
+	MORTALITY = "mortality"
+	FERTILITY = "fertility"
+	LIFE_EXPECTANCY = "life_expectancy"
+	DATAGARDEN_MODEL_NAME = "Demographics"
+
+
+class DemographicsV1Legends:
+	POPULATION = "Population indicators for the region. "
+	MORTALITY = "Mortality indicators for the region. "
+	FERTILITY = "Fertility indicators for the region. "
+	LIFE_EXPECTANCY = "Life expectancy indicators for the region. "
+	DATAGARDEN_MODEL_VERSION = "Version of the data model."
+
+
+L = DemographicsV1Legends
+
+
+class DemographicsV1(DataGardenModel):
+	datagarden_model_version: str = Field(
+		"v1.0", frozen=True, description=L.DATAGARDEN_MODEL_VERSION
+	)
+	population: Population = Field(default_factory=Population, description=L.POPULATION)
+	life_expectancy: LifeExpectancy = Field(
+		default_factory=LifeExpectancy, description=L.LIFE_EXPECTANCY
+	)
+	mortality: Mortality = Field(default_factory=Mortality, description=L.MORTALITY)
+	fertility: Fertility = Field(default_factory=Fertility, description=L.FERTILITY)
+
+
+	

the_datagarden_models-0.0.1/src/datagarden_models/models/demographics/base_demographics.py

@@ -0,0 +1,23 @@
+from pydantic import BaseModel, Field
+
+
+class DemographicsBaseKeys:
+	MALE = "male"
+	FEMALE = "female"
+
+
+class DemographicsBaseLegends:
+	AGE_GENDER_MALE = (
+		"Number of males. " "In number of individuals per age or age group."
+	)
+	AGE_GENDER_FEMALE = (
+		"Number of females. " "In number of individuals per age or age group."
+	)
+
+
+L = DemographicsBaseLegends
+
+
+class AgeGender(BaseModel):
+	male: dict = Field(default_factory=dict, description=L.AGE_GENDER_MALE)
+	female: dict = Field(default_factory=dict, description=L.AGE_GENDER_FEMALE)

the_datagarden_models-0.0.1/src/datagarden_models/models/demographics/fertility.py

@@ -0,0 +1,40 @@
+from pydantic import BaseModel, Field
+
+
+class FertilityV1Legends:
+	TOTAL_BIRTHS = "Total number of births in the population."
+	BIRTHS_BY_AGE = "Number of births categorized by age of the mother."
+	AVERAGE_AGE_MOTHER = "Average age of mothers at childbirth."
+	MEDIAN_AGE_MOTHER = "Median age of mothers at childbirth."
+	FERTILITY_RATE = "Overall fertility rate per woman."
+	FERTILITY_RATE_BY_AGE = "Fertility rates categorized by age of the mother."
+	BIRTH_RATE = "Crude birth rate in number of births per 1000 people."
+
+
+L = FertilityV1Legends
+
+
+class Fertility(BaseModel):
+	total_births: float | None = Field(default=None, description=L.TOTAL_BIRTHS)
+	births_by_age: dict = Field(default_factory=dict, description=L.BIRTHS_BY_AGE)
+	average_age_mother: float | None = Field(
+		default=None, description=L.AVERAGE_AGE_MOTHER
+	)
+	median_age_mother: float | None = Field(
+		default=None, description=L.MEDIAN_AGE_MOTHER
+	)
+	fertility_rate: float | None = Field(default=None, description=L.FERTILITY_RATE)
+	fertility_rate_by_age: dict = Field(
+		default_factory=dict, description=L.FERTILITY_RATE_BY_AGE
+	)
+	birth_rate: float | None = Field(default=None, description=L.BIRTH_RATE)
+
+
+class FertilityV1Keys:
+	TOTAL_BIRTHS = "total_births"
+	BIRTHS_BY_AGE = "births_by_age"
+	AVERAGE_AGE_MOTHER = "average_age_mother"
+	MEDIAN_AGE_MOTHER = "median_age_mother"
+	FERTILITY_RATE = "fertility_rate"
+	FERTILITY_RATE_BY_AGE = "fertility_rate_by_age"
+	BIRTH_RATE = "birth_rate"

the_datagarden_models-0.0.1/src/datagarden_models/models/demographics/life_expectancy.py

@@ -0,0 +1,32 @@
+from pydantic import BaseModel, Field
+
+from .base_demographics import AgeGender
+
+
+class LifeExpectancyV1Keys:
+	LIFE_EXPECTANCY_AT_BIRTH = "life_expectancy_at_birth"
+	REMAINING_LIFE_EXPECTANCY = "remaining_life_expectancy"
+
+
+class LifeExpectancyV1Legends:
+	LIFE_EXPECTANCY_AT_BIRTH = (
+		"Life expectancy per age or age group at birth. "
+		"In years expected to live when born"
+	)
+	REMAINING_LIFE_EXPECTANCY = (
+		"Life expectancy per age or age group at current age. "
+		"In years expected to live as of current age"
+	)
+
+
+L = LifeExpectancyV1Legends
+
+
+class LifeExpectancy(BaseModel):
+	life_expectancy_at_birth: AgeGender = Field(
+		default_factory=AgeGender, description=L.LIFE_EXPECTANCY_AT_BIRTH
+	)
+
+	remaining_life_expectancy: AgeGender = Field(
+		default_factory=AgeGender, description=L.REMAINING_LIFE_EXPECTANCY
+	)

the_datagarden_models-0.0.1/src/datagarden_models/models/demographics/mortality.py

@@ -0,0 +1,33 @@
+from pydantic import BaseModel, Field
+
+from .base_demographics import AgeGender
+
+
+class MortalityV1Legends:
+	DEATHS_BY_AGE = (
+		"Death count per year. " "In number of individuals per age or age group."
+	)
+	TOTAL_DEATHS = "Total number of deaths in a year. " "In number of individuals."
+	INFANT_DEATHS = "Number of infant deaths in the population."
+	INFANT_DEATH_RATE = "Infant death rate per 1000 live births."
+
+
+L = MortalityV1Legends
+
+
+class Mortality(BaseModel):
+	deaths_by_age: AgeGender = Field(
+		default_factory=AgeGender, description=L.DEATHS_BY_AGE
+	)
+	total_deaths: float | None = Field(default=None, description=L.TOTAL_DEATHS)
+	infant_deaths: float | None = Field(default=None, description=L.INFANT_DEATHS)
+	infant_death_rate: float | None = Field(
+		default=None, description=L.INFANT_DEATH_RATE
+	)
+
+
+class MortalityV1Keys:
+	DEATHS_BY_AGE = "deaths_by_age"
+	TOTAL_DEATHS = "total_deaths"
+	INFANT_DEATHS = "infant_deaths"
+	INFANT_DEATH_RATE = "infant_death_rate"

the_datagarden_models-0.0.1/src/datagarden_models/models/demographics/population.py

@@ -0,0 +1,59 @@
+from pydantic import BaseModel, Field
+
+from .base_demographics import AgeGender
+
+
+class PopulationV1Legends:
+	BY_AGE_GENDER = "Age gender distribution for males and females. "
+	TOTAL = "Total population. " "In number of individuals."
+
+	TOTAL_MALE = "Total number of males in the population. " "In number of individuals."
+	TOTAL_FEMALE = (
+		"Total number of females in the population. " "In number of individuals."
+	)
+	POPULATION_TOTAL = (
+		"Total number of persons in the population. " "In number of individuals."
+	)
+	MALE_FEMALE_RATIO = "Males to femal ratio. " "In number of males per 100 females."
+	DENSITY = "Persons per square KM."
+	CHANGE = (
+		"Population change in number of persons. "
+		"In number of individuals per 1000 people."
+	)
+	NATURAL_CHANGE = "Births minus Deaths. In number of individuals."
+	NATURAL_CHANGE_RATE = "Rate of Natural change per 1.000 persons."
+
+
+L = PopulationV1Legends
+
+
+class Population(BaseModel):
+	by_age_gender: AgeGender = Field(
+		default_factory=AgeGender, description=L.BY_AGE_GENDER
+	)
+	total: float | None = Field(default=None, description=L.TOTAL)
+
+	total_male: float | None = Field(default=None, description=L.TOTAL_MALE)
+	total_female: float | None = Field(default=None, description=L.TOTAL_FEMALE)
+	male_to_female_ratio: float | None = Field(
+		default=None, description=L.MALE_FEMALE_RATIO
+	)
+	density: float | None = Field(default=None, description=L.DENSITY)
+	change: float | None = Field(default=None, description=L.CHANGE)
+	natural_change: float | None = Field(default=None, description=L.NATURAL_CHANGE)
+	natural_change_rate: float | None = Field(
+		default=None, description=L.NATURAL_CHANGE_RATE
+	)
+
+
+class PopulationV1Keys:
+	POPULATION = "population"
+	BY_AGE_GENDER = "by_age_gender"
+	TOTAL = "total"
+	TOTAL_MALE = "total_male"
+	TOTAL_FEMALE = "total_female"
+	MALE_TO_FEMALE_RATIO = "male_to_female_ratio"
+	DENSITY = "density"
+	CHANGE = "change"
+	NATURAL_CHANGE = "natural_change"
+	NATURAL_CHANGE_RATE = "natural_change_rate"

the_datagarden_models-0.0.1/src/the_datagarden_models.egg-info/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.1
+Name: the-datagarden-models
+Version: 0.0.1
+Summary: Base data models for the datagarden
+Author: Maarten de Ruyter
+Author-email: "Maarten de Ruyter" <maarten@geodatagarden.com>
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Requires-Dist: pydantic

the_datagarden_models-0.0.1/src/the_datagarden_models.egg-info/SOURCES.txt

@@ -0,0 +1,17 @@
+pyproject.toml
+setup.cfg
+src/datagarden_models/__init__.py
+src/datagarden_models/models/__init__.py
+src/datagarden_models/models/base.py
+src/datagarden_models/models/demographics/__init__.py
+src/datagarden_models/models/demographics/base_demographics.py
+src/datagarden_models/models/demographics/fertility.py
+src/datagarden_models/models/demographics/life_expectancy.py
+src/datagarden_models/models/demographics/migration.py
+src/datagarden_models/models/demographics/mortality.py
+src/datagarden_models/models/demographics/population.py
+src/the_datagarden_models.egg-info/PKG-INFO
+src/the_datagarden_models.egg-info/SOURCES.txt
+src/the_datagarden_models.egg-info/dependency_links.txt
+src/the_datagarden_models.egg-info/requires.txt
+src/the_datagarden_models.egg-info/top_level.txt

the_datagarden_models-0.0.1/src/the_datagarden_models.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

the_datagarden_models-0.0.1/src/the_datagarden_models.egg-info/requires.txt

@@ -0,0 +1 @@
+pydantic

the_datagarden_models-0.0.1/src/the_datagarden_models.egg-info/top_level.txt

@@ -0,0 +1 @@
+datagarden_models