# xnote

**Repository Path**: michaelchou/xnote

## Basic Information

- **Project Name**: xnote
- **Description**: xnote是一个基于webpy开发的笔记系统，提供类似于wiki的资料管理系统以及常用的工具(主要是开发工具)
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 74
- **Created**: 2017-02-21
- **Last Updated**: 2022-05-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# xnote

xnote是一个基于webapp的笔记系统，提供类似于wiki的资料管理系统以及常用的工具(主要是开发工具)

笔记的目的是管理知识，xnote最终目标也是管理个人生活工作中的数据和知识.

注意：本项目主要是个人使用，不考虑并发问题

-----
## 环境依赖

- Python 3

## 开发框架

- webpy (修改版)
- tornado template
- cherrypy (webpy依赖的httpserver)
- sqlite3 (Python自带文件型数据库，不支持多线程操作)

## 前端

- jquery
- marked(markdown解析器)
- qrcode 二维码生成器

## 特性

- 自动搜索`handlers`目录下的Python文件中的handler，可以通过继承约定或者设置`xurls`属性来配置路由，下面是一个例子

```py
# 最简单的handler
class handler:    
    def GET(self):
        return "success"

xurls = ("/test", handler)
# 放在handlers目录下面，然后访问浏览器localhost:1234/test就会看到success
```

- debug模式下自动侦测文件修改并重新加载
- `handlers`目录下的模块使用全局变量task声明定时任务,taskname是任务名称,interval是触发频率，单位是秒
- 支持文件断点续传

## 配置运行
- config/users.ini 用户配置，管理员可以添加账户，不支持注册

```
; 用户名
[admin]
; 密码
password=123456
```

- 启动服务器`python app.py`, 默认1234端口, 浏览器打开http://localhost:1234/ 即可

## 协议

- Apache License (tornado)