Skip to content

Commit

Permalink
补全 README 等信息
Browse files Browse the repository at this point in the history
  • Loading branch information
kaaass committed Oct 1, 2021
1 parent d128311 commit ecf9d01
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ costflow.json
beancount_bot.yml
bot.session
*.egg-info/
.pypirc
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,40 @@
# beancount_bot
A telegram bot designed for Beancount

适用于 Beancount 记账的 Telegram 机器人

![GitHub](https://img.shields.io/github/license/kaaass/beancount_bot)
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/kaaass/beancount_bot?color=green&label=version)
![PyPI](https://img.shields.io/pypi/v/beancount_bot)

## Features

- 支持简易鉴权
- 内建自由且强大的模板语法,适用于各种记账需求
- 允许通过插件扩展记账语法

## 安装

```shell
pip install beancount_bot
```

## 使用

1. 下载示例配置文件 `beancount_bot.example.yml``template.example.yml`
2. 修改后保存为 `beancount_bot.yml``template.yml`
3. 执行 `beancount_bot`

## 推荐插件

1. [kaaass/beancount_bot_costflow](https://github.com/kaaass/beancount_bot_costflow)

欢迎在 Issue 推荐优秀插件。

## 插件开发

请查阅项目 Wiki。

## Roadmap

1. [ ] 支持定时备份
2. [ ] 支持账单导入
8 changes: 7 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
from setuptools import setup

from beancount_bot import __VERSION__

with open("requirements.txt", "r") as f:
Expand All @@ -23,5 +24,10 @@
author_email='[email protected]',
description='A telegram bot designed for Beancount',
long_description=long_description,
long_description_content_type="text/markdown"
long_description_content_type="text/markdown",
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
]
)

0 comments on commit ecf9d01

Please sign in to comment.