Nimbo 프로젝트 설치 및 운영 가이드

1. 프로젝트 디렉토리 구조 및 구성 요소

Nimbo 프로젝트는 효율적인 코드 관리와 모듈화를 위해 체계적인 디렉토리 구조를 가지고 있습니다. 전체적인 프로젝트 레이아웃은 다음과 같습니다.

nimbo/
├── bin/                # 실행 스크립트 모음 (Unix/Windows)
│   ├── nimbo
│   └── nimbo.bat
├── conf/               # 애플리케이션 및 로그 설정 파일
│   ├── config.yaml
│   └── logging.yaml
├── docs/               # 문서화 파일 (가이드 및 기여 방법)
│   ├── README.md
│   └── CONTRIBUTING.md
├── src/                # 핵심 소스 코드
│   ├── main.py         # 서비스 엔트리 포인트
│   ├── utils/          # 공통 유틸리티 (로거, 헬퍼 등)
│   │   ├── helper.py
│   │   └── logger.py
│   └── modules/        # 비즈니스 로직 모듈
│       ├── module1.py
│       └── module2.py
├── tests/              # 단위 및 통합 테스트 코드
│   ├── test_main.py
│   └── test_utils.py
├── .gitignore          # Git 관리 제외 대상 설정
├── LICENSE             # 프로젝트 라이선스
└── requirements.txt    # 의존성 패키지 목록

각 주요 디렉토리의 역할은 다음과 같습니다.

  • bin/: 환경에 구애받지 않고 애플리케이션을 구동하기 위한 실행 파일이 포함되어 있습니다.
  • conf/: 서비스 운영 환경에 따라 변경이 필요한 설정 값들을 관리합니다.
  • src/: 실제 로직이 구현되는 공간으로, 기능별로 모듈화되어 관리됩니다.
  • tests/: 코드의 안정성을 보장하기 위한 테스트 슈트가 포함됩니다.

2. 엔트리 포인트: 메인 애플리케이션 실행

Nimbo 프로젝트의 구동은 src/main.py 파일을 통해 이루어집니다. 이 파일은 시스템 환경을 초기화하고 필요한 엔진 모듈을 로드하는 역할을 수행합니다.

import sys
from conf import config
from src.utils import logger
from src.modules import module1, module2

def bootstrap():
    # 로그 시스템 활성화
    logger.setup_logging()
    
    # 전역 설정 로드
    app_settings = config.initialize_env()
    
    # 핵심 비즈니스 모듈 구동
    module1.run()
    module2.run()

if __name__ == "__main__":
    try:
        bootstrap()
    except Exception as err:
        print(f"애플리케이션 시작 중 오류 발생: {err}")
        sys.exit(1)

실행 흐름은 다음과 같은 단계를 거칩니다.

  1. 로깅 초기화: logger.setup_logging()을 호출하여 시스템 로그 기록을 시작합니다.
  2. 설정 로드: config.initialize_env()를 통해 외부 설정 파일을 읽어들여 메모리에 적재합니다.
  3. 모듈 실행: 정의된 각 기능 모듈을 순차적으로 활성화하여 서비스를 가동합니다.

3. 환경 설정 상세 정보

설정 파일은 conf/ 디렉토리에 위치하며 YAML 형식을 사용하여 가독성을 높였습니다.

시스템 설정 (config.yaml)

애플리케이션의 기본 메타데이터와 데이터베이스 연결 정보를 정의합니다.

server:
  app_name: "Nimbo_Service"
  env_mode: "production"
  version: "1.0.0"

storage_provider:
  address: "127.0.0.1"
  port: 3306
  username: "admin"
  secret: "secure_password"
  database: "nimbo_core"

log_settings:
  default_level: "ERROR"
  output_path: "logs/nimbo_error.log"

로그 설정 (logging.yaml)

로그 출력 형식과 핸들러 정보를 구성합니다.

version: 1
disable_existing_loggers: false

formatters:
  standard:
    format: "[%(levelname)s] %(asctime)s - %(name)s: %(message)s"

handlers:
  stream:
    class: logging.StreamHandler
    level: INFO
    formatter: standard
    stream: ext://sys.stdout

loggers:
  nimbo_logger:
    level: DEBUG
    handlers: [stream]
    propagate: no

관리자는 위 설정 파일들을 수정하여 코드 변경 없이도 데이터베이스 연결 정보나 로그 기록 수준을 유연하게 제어할 수 있습니다.

태그: python Software-Architecture configuration-management YAML logging

11월 17일 03:36에 게시됨