Hexo-Circle-Of-Friends 项目使用教程

Hexo-Circle-Of-Friends 项目使用教程

hexo-circle-of-friends项目地址:https://gitcode.com/gh_mirrors/hex/hexo-circle-of-friends

1. 项目的目录结构及介绍

Hexo-Circle-Of-Friends 项目的目录结构如下：

hexo-circle-of-friends/
├── README.md
├── app.py
├── config.json
├── requirements.txt
├── utils/
│   ├── __init__.py
│   ├── fetch_data.py
│   ├── parse_data.py
│   └── save_data.py
└── templates/
    ├── index.html
    └── style.css

目录结构介绍

• README.md: 项目说明文档。
• app.py: 项目的启动文件。
• config.json: 项目的配置文件。
• requirements.txt: 项目依赖的Python包列表。
• utils/: 包含项目使用的各种工具函数。
  • __init__.py: 使 utils 目录成为一个Python模块。
  • fetch_data.py: 用于获取友链文章数据的模块。
  • parse_data.py: 用于解析获取到的数据的模块。
  • save_data.py: 用于保存解析后的数据的模块。
• templates/: 包含项目的HTML模板和CSS样式文件。
  • index.html: 主页面的HTML模板。
  • style.css: 主页面的CSS样式文件。

2. 项目的启动文件介绍

app.py 是项目的启动文件，主要负责启动Web服务并处理请求。以下是 app.py 的主要内容：

from flask import Flask, render_template
from utils.fetch_data import fetch_friends_articles
from utils.parse_data import parse_articles
from utils.save_data import save_articles

app = Flask(__name__)

@app.route('/')
def index():
    articles = fetch_friends_articles()
    parsed_articles = parse_articles(articles)
    save_articles(parsed_articles)
    return render_template('index.html', articles=parsed_articles)

if __name__ == '__main__':
    app.run(debug=True)

启动文件介绍

• 导入必要的模块和函数。
• 创建Flask应用实例。
• 定义主页路由 /，在该路由中调用 fetch_friends_articles 获取友链文章，调用 parse_articles 解析文章，调用 save_articles 保存文章，并渲染 index.html 模板。
• 在 if __name__ == '__main__': 中启动Flask应用。

3. 项目的配置文件介绍

config.json 是项目的配置文件，用于配置项目的各种参数。以下是 config.json 的一个示例：

{
    "friends_links": [
        "https://example1.com/atom.xml",
        "https://example2.com/feed.xml"
    ],
    "database": {
        "type": "sqlite",
        "path": "data.db"
    },
    "server": {
        "host": "0.0.0.0",
        "port": 5000
    }
}

配置文件介绍

• friends_links: 包含友链的RSS或Atom链接。
• database: 配置数据库类型和路径。
  • type: 数据库类型，如 sqlite。
  • path: 数据库文件路径。
• server: 配置服务器的主机地址和端口。
  • host: 服务器主机地址。
  • port: 服务器端口。

以上是 Hexo-Circle-Of-Friends 项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用该项目。

hexo-circle-of-friends项目地址:https://gitcode.com/gh_mirrors/hex/hexo-circle-of-friends