库和命令行界面,与Fachschaft TF Uni Freiburg的饮料管理系统交互。
dmsclient的Python项目详细描述
python3库具有命令行界面,可以与student council TF Uni Freiburg的饮料管理系统(dms)进行交互。
开始
先决条件
你需要python 3.5或更新的和pip。 为了进行开发,您还需要在计算机上安装git。
安装
只需从pypi安装dmsclient库和命令行界面:
pip3 install dmsclient
对于开发人员,建议从源viedevelop安装。 然后,代码中的所有更改都将自动在库和命令行中可用,而无需重新安装。
git clone git@<git url>:<user>/dmsclient.git
cd dmsclient
python3 setup.py develop
命令行
dmsclient的安装提供了一个命令行接口dms。 为了进行身份验证,您必须在DMS配置文件设置中生成令牌密钥。 将令牌添加到主文件夹中的.dmsrc文件中。
[DEFAULT] Token = XxxxxXXXxxxxxXXXXxxxxxxxXXX
然后可以开始使用dms。您可以通过
dms --help
用户和产品名称不必完全添加,而是根据键入的内容进行估计。例如:
$ dms buy apfel -u must Buy Apfelschorle (0.70€)for Max Mustermann? [Y/n]
库
要通过rest与dms通信,可以使用这个库提供的DmsClient类。 身份验证通过令牌密钥提供,您可以在DMS配置文件设置中生成令牌密钥。 DmsClient通常返回深对象,其中id被相应的对象替换。
示例代码:
fromrandomimportsamplefromdmsclientimportDmsClientdeforder_random_stuff_for_last_customer(dms):available_products=(pforpindms.productsifp.quantity>0)random_product=sample(available_products,1)[0]last_sale=dms.sale_history(num_days=1)[0]dms.add_order(random_product.id,last_sale.profile.id)token='XxxxxXXXxxxxxXXXXxxxxxxxXXX'api_endpoint='https://dms.fachschaft.tf/api'dms=DmsClient(token,api_endpoint)order_random_stuff_for_last_customer(dms)
许可证
dmsclient在MIT License
致谢
非常感谢DMS和DMS-API开发人员!