# KnowledgePuzzleSystem

**Repository Path**: Micestark/knowledge-puzzle-system

## Basic Information

- **Project Name**: KnowledgePuzzleSystem
- **Description**: 应用场景是我经常会发送存如一两句话作为一条知识或者想法，然后日积月累之后会有很多条知识碎片。某一天我想起我曾经记录的某一条信息，只能想到一些词语片段，所以我输入一两个字来搜索所有可能相关的知识碎片。
- **Primary Language**: Python
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-09-05
- **Last Updated**: 2024-09-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# KnowledgePuzzleSystem

#### 介绍
应用场景是我经常会发送存如一两句话作为一条知识或者想法，然后日积月累之后会有很多条知识碎片。某一天我想起我曾经记录的某一条信息，只能想到一些词语片段，所以我输入一两个字来搜索所有可能相关的知识碎片。

#### 软件架构
软件架构说明


#### 安装教程

```
pip install -r requirements.txt
```

#### 使用说明

1.  启动kps server
```
cd backend/src/
uvicorn main:app --host=0.0.0 --port=8900 --reload --log-config=log_conf.yaml
```
2.  配置命令行
编辑.bashrc
```
alias kps = "env/bin/python kps_cli.py"
```
3. 命令行使用
```
kps --help
 Usage: kps_cli.py [OPTIONS] COMMAND [ARGS]...

╭─ Options ────────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current shell.  │
│ --show-completion             Show completion for the current shell, to  │
│                               copy it or customize the installation.     │
│ --help                        Show this message and exit.                │
╰──────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────╮
│ a   add knowledge record                                                 │
│ s   search knowledge record                                              │
╰──────────────────────────────────────────────────────────────────────────╯
> kps a "my name is fire"
add my name is fire success!

> kps a "my name is ice"
add my name is ice success!

> kps s name
my name is ice(2024-09-06 17:55:20.953000)
my name is fire(2024-09-06 17:55:20.953000)

> kps fire 
my name is fire(2024-09-06 17:55:20.953000)
```

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)