Coverage for .tox/coverage/lib/python3.11/site-packages/wuttjamaican/db/model/__init__.py: 100%

1# -*- coding: utf-8; -*- 

2################################################################################ 

3# 

4# WuttJamaican -- Base package for Wutta Framework 

5# Copyright © 2023-2024 Lance Edgar 

6# 

7# This file is part of Wutta Framework. 

8# 

9# Wutta Framework is free software: you can redistribute it and/or modify it 

10# under the terms of the GNU General Public License as published by the Free 

11# Software Foundation, either version 3 of the License, or (at your option) any 

12# later version. 

13# 

14# Wutta Framework is distributed in the hope that it will be useful, but 

15# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 

16# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 

17# more details. 

18# 

19# You should have received a copy of the GNU General Public License along with 

20# Wutta Framework. If not, see <http://www.gnu.org/licenses/>. 

21# 

22################################################################################ 

23""" 

24Data Models 

25 

26This is the default :term:`app model` module. 

27 

28This namespace exposes the following: 

29 

30* :class:`~wuttjamaican.db.model.base.Base` 

31* :func:`~wuttjamaican.db.util.uuid_column()` 

32* :func:`~wuttjamaican.db.util.uuid_fk_column()` 

33* :class:`~wuttjamaican.db.util.UUID` 

34 

35And the :term:`data models <data model>`: 

36 

37* :class:`~wuttjamaican.db.model.base.Setting` 

38* :class:`~wuttjamaican.db.model.base.Person` 

39* :class:`~wuttjamaican.db.model.auth.Role` 

40* :class:`~wuttjamaican.db.model.auth.Permission` 

41* :class:`~wuttjamaican.db.model.auth.User` 

42* :class:`~wuttjamaican.db.model.auth.UserRole` 

43* :class:`~wuttjamaican.db.model.upgrades.Upgrade` 

44 

45And the :term:`batch` model base/mixin classes: 

46 

47* :class:`~wuttjamaican.db.model.batch.BatchMixin` 

48* :class:`~wuttjamaican.db.model.batch.BatchRowMixin` 

49""" 

50 

51from wuttjamaican.db.util import uuid_column, uuid_fk_column, UUID 

52 

53from .base import Base, Setting, Person 

54from .auth import Role, Permission, User, UserRole 

55from .upgrades import Upgrade 

56from .batch import BatchMixin, BatchRowMixin