将Xero连接到数据库连接器,以来回传输信息。
xero-db-connector的Python项目详细描述
Xero数据库连接器
将Xero连接到数据库以来回传输信息。在
安装
此项目需要Python 3+。在
- 在
下载并使用此项目(复制到您的项目中,等等)。在
在 - 在
从pip安装它。在
在$ pip install xero-db-connector
使用
要使用此连接器,您需要Xero凭据-特别是密钥文件和使用者密钥。在
下面是示例用法。在
^{pr2}$贡献
要对这个项目做出贡献,请遵循以下步骤
- 派生并克隆存储库。在
- 运行
pip install -r requirements.txt
- 安装pylint预提交挂钩
- 创建文件
.git/hooks/pre-commit
- 复制并粘贴文件中的以下行-
#!/usr/bin/env bash git-pylint-commit-hook
在
- 创建文件
- 进行必要的更改
- 运行单元测试以确保一切正常
单元测试
要运行单元测试,请按以下方式运行pytest:
python -m pytest test/unit
你应该看到这样的画面:
================================================================== test session starts ==================================================================
platform darwin -- Python 3.7.4, pytest-5.2.2, py-1.8.0, pluggy-0.13.0
rootdir: /Users/siva/src/xero-db-connector, inifile: pytest.ini
plugins: mock-1.11.2, cov-2.8.1
collected 3 items
test/unit/test_mocks.py::test_xero_mock_setup PASSED [ 33%]
test/unit/test_mocks.py::test_dbconn_mock_setup PASSED [ 66%]
test/unit/test_mocks.py::test_xec_mock_setup PASSED [100%]
=================================================================== 3 passed in 0.10s ===================================================================
集成测试
要运行单元测试,您需要一种机制来连接到真正的Xero帐户。具体地说,您需要一个keyfile和一个consumerkey,这两个都可以从xero developer门户获得。在运行集成测试之前,请设置以下环境变量:
export XERO_PRIVATE_KEYFILE=<path_to_keyfile>
export XERO_CONSUMER_KEY=<string>
python -m pytest test/integration
代码覆盖率
要获取代码覆盖率报告,请运行以下命令:
python-mpytest--cov=xero_db_connector<snippedoutput>NameStmtsMissCover---------------------------------------------------xero_db_connector/__init__.py00100%xero_db_connector/extract.py1060100%xero_db_connector/load.py520100%---------------------------------------------------TOTAL1580100%
要获取html报告,请运行以下命令:
python-mpytest--cov=xero_db_connector--cov-reporthtml:cov_html
我们想保持95%以上的代码覆盖率这个项目在任何时候。在
许可证
这个项目是在MIT许可下授权的-请参阅LICENSE文件了解详细信息
- 项目
标签: