django-versionlog

重要提示: master 分支是开发分支，可能处于 不稳定或者不可用状态 。请通过releases 而非 master 去获取稳定的软件包

django-versionlog是为网站开发者提供版本日志快速接入的功能模块，支持django框架，兼容python2和python3。开发者只需在项目中进行简单的配置和维护版本日志目录中的md文件，即可在项目中向用户展示网站版本的更新迭代内容。

Overview

Quick Start

本节以单页面对话框版本日志为例，展示使用本功能模块最简单的流程：

安装版本日志功能模块(内部仓库)：
```
pip install django-versionlog 
```
在项目配置文件中的INSTALLED_APPS内添加version_log：
```
INSTALLED_APPS += (
    'version_log'
)
```

在项目的urls.py中配置路由：

import version_log.config as config
urlpatterns = [
    ...,
    url(r'^{}'.format(config.ENTRANCE_URL), include('version_log.urls', namespace='version_log')),
]

创建和初始化对应表：

python manage.py makemigrations version_log
python manage.py migrate

收集静态文件&启动项目：
```
python manage.py collectstatic
python manage.py runserver
```
项目运行后，会在项目根目录下创建版本日志文件目录version_logs_md，该目录用于存放开发者网站版本日志文件。

注意：这里假设项目配置变量中BASE_DIR指向工程根目录。
添加版本日志文件：

每个版本的日志对应于一个md文件，同时md文件命名需与版本号对应。命名格式可为 版本号_版本日期.md 或 版本号.md。前者会以文件名中的日期作为版本日期，后者会以文件最新修改日期作为版本日期。

建议版本号的规则满足正则：[vV](\d+\.){2,4}md，如：v1.1.md, V1.2.3.md等，命名风格最好统一。版本文件命名中的日期格式可通过FILE_TIME_FORMAT进行配置，默认为%Y%m%d，如20201104等。

开发者需将准备好的版本日志文件都放到version_logs_md文件夹中，1.3.0之后版本模块不再对文件名进行强制校验，所以开发者需保证放入文件夹中的文件都是符合命名规范且可解析的版本日志文件。
重启项目：
```
python manage.py runserver
```
查看效果：打开链接 {SITE_URL}/version_log/ 即可查看效果，其中{SITE_URL}为开发者网站地址。