diff --git a/src/brms/__init__.py b/src/brms/__init__.py index 0f96f55..fe8ff4f 100644 --- a/src/brms/__init__.py +++ b/src/brms/__init__.py @@ -1,4 +1,11 @@ -"""BRMS - Bank Risk Management Simulation.""" +"""BRMS - Bank Risk Management Simulation. + +BRMS is an educational tool designed to provide users with an in-depth understanding of bank risk management practices. +It allows users to simulate and respond to various risk scenarios, and analyze the impact on a bank's financial health. + +BRMS generally follows the Model-View-Controller (MVC) design pattern for maintainability. +Additional modules are to implement core functionalities that are independent of the GUI. +""" import importlib.metadata import os diff --git a/src/brms/accounting/__init__.py b/src/brms/accounting/__init__.py index 0729cbc..c4eb72e 100644 --- a/src/brms/accounting/__init__.py +++ b/src/brms/accounting/__init__.py @@ -1 +1 @@ -"""Module providing basic double-entry accounting system for a bank.""" +"""Module for bank accounting.""" diff --git a/src/brms/accounting/account.py b/src/brms/accounting/account.py index b8010b0..77ab890 100644 --- a/src/brms/accounting/account.py +++ b/src/brms/accounting/account.py @@ -1,3 +1,5 @@ +"""Module for various types of accounts used in a bank's chart of accounts.""" + from collections import UserDict from collections.abc import Generator from dataclasses import dataclass, field diff --git a/src/brms/accounting/journal.py b/src/brms/accounting/journal.py index 23acf8d..4220379 100644 --- a/src/brms/accounting/journal.py +++ b/src/brms/accounting/journal.py @@ -1,4 +1,4 @@ -"""Module for handling journal entries in accounting.""" +"""Module for accounting journal and entries.""" import datetime from abc import ABC, abstractmethod diff --git a/src/brms/accounting/ledger.py b/src/brms/accounting/ledger.py index 9ac1f88..38a1f88 100644 --- a/src/brms/accounting/ledger.py +++ b/src/brms/accounting/ledger.py @@ -1,4 +1,4 @@ -"""Defines the Ledger class, which represents a ledger in an accounting system.""" +"""Module for accounting ledger.""" import copy import datetime diff --git a/src/brms/accounting/report.py b/src/brms/accounting/report.py index 47fd544..f9cf7d9 100644 --- a/src/brms/accounting/report.py +++ b/src/brms/accounting/report.py @@ -1,4 +1,4 @@ -"""Provides classes for generating financial statements and reports.""" +"""Module for financial statements and reports.""" import datetime from abc import ABC, abstractmethod diff --git a/src/brms/controllers/__init__.py b/src/brms/controllers/__init__.py index e69de29..47f3b14 100644 --- a/src/brms/controllers/__init__.py +++ b/src/brms/controllers/__init__.py @@ -0,0 +1 @@ +"""Module for MVC controllers in the GUI application.""" diff --git a/src/brms/data/__init__.py b/src/brms/data/__init__.py index 6fe3535..e1468af 100644 --- a/src/brms/data/__init__.py +++ b/src/brms/data/__init__.py @@ -1,3 +1,5 @@ +"""Module for simulation data loading.""" + import os DEFAULT_DATA_FOLDER = os.path.join(os.path.dirname(__file__), "default") diff --git a/src/brms/data/data_loader.py b/src/brms/data/data_loader.py index 35ced67..1d7fd26 100644 --- a/src/brms/data/data_loader.py +++ b/src/brms/data/data_loader.py @@ -1,3 +1,5 @@ +"""Module for data loader.""" + import os from abc import ABC, abstractmethod diff --git a/src/brms/data/default/__init__.py b/src/brms/data/default/__init__.py index 91aad66..4ca1e2e 100644 --- a/src/brms/data/default/__init__.py +++ b/src/brms/data/default/__init__.py @@ -1,3 +1,5 @@ +"""Module for default simulation.""" + import datetime import random from collections.abc import Generator diff --git a/src/brms/data/schema.py b/src/brms/data/schema.py index 9cda63b..403349d 100644 --- a/src/brms/data/schema.py +++ b/src/brms/data/schema.py @@ -1,3 +1,5 @@ +"""Module for schemas in the BRMS.""" + from brms.models.base import ScenarioData SCHEMA = { diff --git a/src/brms/instruments/__init__.py b/src/brms/instruments/__init__.py index e69de29..30ca3a9 100644 --- a/src/brms/instruments/__init__.py +++ b/src/brms/instruments/__init__.py @@ -0,0 +1 @@ +"""Module for various financial instruments.""" diff --git a/src/brms/metrics/__init__.py b/src/brms/metrics/__init__.py index e69de29..738e2a6 100644 --- a/src/brms/metrics/__init__.py +++ b/src/brms/metrics/__init__.py @@ -0,0 +1 @@ +"""Module for computing Basel III metrics.""" diff --git a/src/brms/models/__init__.py b/src/brms/models/__init__.py index e69de29..88fc40d 100644 --- a/src/brms/models/__init__.py +++ b/src/brms/models/__init__.py @@ -0,0 +1 @@ +"""Module for MVC models in the GUI application.""" diff --git a/src/brms/services/__init__.py b/src/brms/services/__init__.py index e69de29..babd9b3 100644 --- a/src/brms/services/__init__.py +++ b/src/brms/services/__init__.py @@ -0,0 +1,5 @@ +"""Module for various computing services. + +The services module contains various service classes and functions that +provide core functionalities and business logic for the BRMS application. +""" diff --git a/src/brms/utils/__init__.py b/src/brms/utils/__init__.py index 2c51f79..761dc2a 100644 --- a/src/brms/utils/__init__.py +++ b/src/brms/utils/__init__.py @@ -1,3 +1,5 @@ +"""Module for utility functions and classes.""" + import datetime import time from abc import ABC, abstractmethod diff --git a/src/brms/views/__init__.py b/src/brms/views/__init__.py index e69de29..e1e72f2 100644 --- a/src/brms/views/__init__.py +++ b/src/brms/views/__init__.py @@ -0,0 +1 @@ +"""Module for MVC views in the GUI application."""