这是TataruBook的帮助文档。

TataruBook是什么?

TataruBook是一个使用简化的复式记账法的、基于SQL表和视图的、以命令行方式执行的、面向个人或家庭的记账和理财收益计算工具软件。该工具可辅助用户把资产、账户、交易明细等数据输入DB文件,并计算出净资产、分类收入支出、投资收益率等各种统计数据。

如何下载和安装TataruBook?

TataruBook可以以可执行程序的形态使用,也可以以Python脚本的形态使用。对应的两种下载和安装方式如下:

在Windows 10或更高版本中的可执行程序

Github发布页面或者Gitee发布页面下载tatarubook.zip包,将其解压缩到任何一个文件夹,然后运行其中的install.bat脚本进行安装(安装过程中可能会要求授予管理员权限)。安装完成后,即可通过文件资源管理器中的右键快捷菜单来使用TataruBook的功能。

install.bat只会修改注册表来添加快捷菜单项,不会向任何系统目录增加文件。如果你移动了TataruBook程序文件夹的位置,则需要重新运行install.bat。运行uninstall.bat可以移除已添加的快捷菜单项。

注意:压缩包中的tatarubook.exe仅供命令行调用,不要直接双击运行该文件。TataruBook运行时需要依赖压缩包中的多个文件,因此,请确保在同一目录解压tatarubook.zip中的所有文件,且保持压缩包里的目录结构。

Python脚本

如果你的系统中安装了Python 3.8或更高版本,那么你也可以从Github仓库或者Gitee仓库的源代码文件中下载tatarubook.py脚本,然后用Python解释器运行tatarubook.py脚本来使用TataruBook的功能。

这种方式只需下载一个体积很小的脚本文件,无需解压和安装,能在任何操作系统上运行,但是只能以命令行的方式使用TataruBook。对于使用Windows 10或更高版本的用户,推荐用第一种方式来获得快捷菜单操作的便利性。

如何使用TataruBook进行记账?

你需要先了解一些概念:

TataruBook只是一个程序,它自身并不包含任何财务数据,所有的数据都被保存在DB文件中,DB文件是由用户命名且后缀名为.db的文件。TataruBook可以对命令行中指定的DB文件进行操作。

什么是DB文件?

DB文件是保存了财务数据和相关报表的文件。每个DB文件都是SQLite格式的数据库文件,可以使用任何支持SQLite文件格式的软件进行查看和修改。

如果使用其他软件来查看和修改TataruBook生成的DB文件,请确保这些软件支持SQLite的一些新特性(如STRICT属性)。例如:若要使用DB Browser for SQLite来打开DB文件,则必须用DB Browser for SQLitenightly版本才能支持STRICT属性。

注意:使用其他软件修改DB文件时,只能添加、删除、修改记录,不可修改表和视图的定义!否则,TataruBook将无法保证以后还能正确操作这个DB文件。

通常来说,一个用户或家庭/组织的所有历史财务数据都放在同一个DB文件中。DB文件中有一些报表会把该DB文件中所有的内部账户看作一个投资组合(portfolio),并展示这个投资组合的净资产、收益率和资金流入流出情况。因此,希望参与统计的账户数据都应当放在同一个DB文件中,TataruBook不支持跨DB文件进行计算。

有些用户习惯于按时间周期分割财务数据,比如把每一年的财务数据放在一个独立的DB文件中。使用TataruBook时没有必要做这种分割,因为TataruBook支持展示任意历史时间段(精确到天)的财务报表。把所有历史财务数据存放在一个DB文件中可以保持连贯而准确的财务记录,省去新建DB文件时需要导入每个账户历史余额的麻烦。

我该从哪儿开始?

对于第一次使用TataruBook的用户,推荐阅读快速入门。这篇教程通过由浅入深的使用案例帮助新用户快速掌握TataruBook的主要用法。

表和视图介绍了DB文件中所有的表和视图,以及它们之间的关系。当你对某些表或视图的字段有疑问时,可参阅此文档。

用户手册介绍了TataruBook的所有命令用法和注意事项。

如果你觉得DB文件中的现有视图还不能满足自己,并且你知道如何使用SQL语言,那么,你可以使用其他支持SQLite格式的软件(需确保这些软件支持SQLite的一些新特性)来打开DB文件,并自己编写SQL语句对数据进行查询和编辑(但是不要修改已有表和视图的定义)。

对于投资者来说,投资收益率是倍受关注的。TataruBook中有多个视图从各个角度呈现投资收益率。收益率计算方法中详细介绍了各种收益率的计算方法,以及其在TataruBook的视图中是如何被使用的。

怎样提升外部数据的导入效率是实际记账中的一个关键难题,数据导入指南给出了高效的数据处理和导入方法供参考。

如何反馈问题和需求?

请在Github仓库或者Gitee仓库上提交issue,我会查看并进行回复。