diff --git a/.gitignore b/.gitignore index 00c27fa..22ae8e5 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,4 @@ costflow.json beancount_bot.yml bot.session *.egg-info/ +.pypirc \ No newline at end of file diff --git a/README.md b/README.md index 5c84f64..f324edd 100644 --- a/README.md +++ b/README.md @@ -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. [ ] 支持账单导入 diff --git a/setup.py b/setup.py index b8d3e9a..efc4dc5 100644 --- a/setup.py +++ b/setup.py @@ -1,4 +1,5 @@ from setuptools import setup + from beancount_bot import __VERSION__ with open("requirements.txt", "r") as f: @@ -23,5 +24,10 @@ author_email='admin@kaaass.net', 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", + ] )