Skip to content

hktkzyx/hktkzyx-toolbox

Repository files navigation

hktkzyx toolbox 文档

Official Website | @hktkzyx/hktkzyx-toolbox

hktkzyx toolbox 是 hktkzyx 的一个工具箱应用。 目前该工具箱主要采用命令行接口,具有一下功能:

  • 养老保险计算

    计算城镇居民养老保险的预期待遇

  • LED 分压电阻、电流计算

    计算 LED 的分压电阻大小

  • 标准电阻查询

    根据电阻值查询标准电阻

GitHub Workflow Status Codecov PyPI - License PyPI PyPI - Python Version GitHub last commit

安装

pip install hktkzyx-toolbox

使用

查询金融工具箱的命令和用法

hktkzyx-finance --help

查询电子工具箱的命令和用法

hktkzyx-electronics --help

如何贡献

十分欢迎 Fork 本项目! 欢迎修复 bug 或开发新功能。 开发时请遵循以下步骤:

  1. 使用 poetry 作为依赖管理

    克隆项目后,在项目文件夹运行

    poetry install
  2. 使用 pre-commit 并遵守 Conventional commits 规范

    安装 pre-commit 并运行

    pre-commit install -t pre-commit -t commit-msg

    建议使用 commitizen 提交您的 commits。

  3. 建议遵循 gitflow 分支管理策略

    安装 git-flow 管理您的分支并运行

    git config gitflow.branch.master main
    git config gitflow.prefix.versiontag v
    git flow init -d
  4. PR 代码到 develop 分支

*[PR]: Pull request

许可证

Copyright (c) 2022 Brooks YUAN.

Environment Sensor Bluetooth firmware is licensed under Mulan PSL v2.

You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2.

THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.

See the Mulan PSL v2 for more details.