QLog 开源项目使用教程

QLog 开源项目使用教程

QLog Amateur radio logbook software 项目地址: https://gitcode.com/gh_mirrors/ql/QLog

1. 项目目录结构及介绍

QLog 是一个开源的日志管理项目，其目录结构如下：

QLog/
├── bin/                      # 存放可执行文件
├── config/                   # 配置文件目录
│   └── qlog_config.json       # QLog 配置文件
├── doc/                      # 项目文档
├── lib/                      # 项目核心库文件
│   ├── qlog.py               # QLog 日志处理核心模块
│   └── ...
├── scripts/                  # 脚本文件，用于项目操作
├── src/                      # 源代码目录
│   ├── main.py               # 项目入口文件
│   └── ...
├── tests/                    # 测试代码目录
├── .gitignore                # 指定 Git 忽略的文件
├── README.md                 # 项目说明文件
└── requirements.txt          # 项目依赖文件

• bin/：存放项目的可执行文件。
• config/：存放项目的配置文件。
• doc/：存放项目的文档。
• lib/：存放项目的核心库文件。
• scripts/：存放项目相关的脚本文件。
• src/：存放项目的源代码。
• tests/：存放项目的测试代码。
• .gitignore：指定 Git 忽略的文件。
• README.md：项目说明文件。
• requirements.txt：项目依赖文件。

2. 项目的启动文件介绍

项目的启动文件位于 src/main.py。以下是 main.py 的基本内容：

import sys
import os
from qlog import QLog

def main():
    # 初始化 QLog 实例
    qlog = QLog(config_path='config/qlog_config.json')

    # 配置日志
    qlog.config_log()

    # 这里是项目的具体逻辑
    qlog.info("项目启动成功！")

    # ... 其他代码

if __name__ == '__main__':
    main()

在 main.py 文件中，首先导入必要的模块，然后定义了 main 函数，该函数负责初始化 QLog 实例、配置日志，并执行项目的具体逻辑。

3. 项目的配置文件介绍

项目的配置文件位于 config/qlog_config.json。以下是 qlog_config.json 的基本内容：

{
    "version": "1.0.0",
    "log_level": "INFO",
    "log_format": "[%(asctime)s] [%(levelname)s] [%(name)s] [%(message)s]",
    "log_file_path": "logs/qlog.log",
    "log_max_size": 10,
    "log_backup_count": 5
}

在 qlog_config.json 文件中，定义了以下配置：

• version：QLog 的版本号。
• log_level：日志级别。
• log_format：日志的输出格式。
• log_file_path：日志文件的存储路径。
• log_max_size：单个日志文件的最大大小（单位：MB）。
• log_backup_count：日志文件备份的数量。

QLog Amateur radio logbook software 项目地址: https://gitcode.com/gh_mirrors/ql/QLog