这是用于向EvaluationKit API发出请求的库。
evalkit-api-client的Python项目详细描述
evalkit api客户端
=
=
[综述]
[测试]
[测试]
[文档]
[文档]
[安装]
[安装]
[使用]
[使用]
[贡献]
[贡献]
[参考文献]
[综述]
[综述]
[综述]
[综述]
[综述]
[综述]
[安装]
[使用]
[使用]
[使用]
[贡献]
[贡献]
[贡献]
[贡献]
[参考文献]
[参考br/>——
用于向EvaluationKit API发出请求的库。
测试
----
此项目使用[tox]进行测试(https://tox.readthedocs.io/en/latest/)。
这个项目的tox运行:
*[flake8](http://flake8.pycqa.org/en/latest/)
*[mypy](http s://github.com/python/mypy)
*[pytest](https://docs.pytest.org/en/latest/)
创建测试覆盖率报告:
````
$tox-ecov
```
deployment
----
pypi的deployment使用tox:tox:网址:
https://lcary.github.io/canvas lms tools/
installation
----
使用pip:
pip install evalkit_api_client
或克隆repo:
cd canvas lms tools/evalkit_api_client
python setup.py install
用法
----
您的项目的'requirements.txt`
文件是使用客户端的预期方式。
='xxxxxxxxxxxxxxxx thisxisxnotxaxrealxtokenxxxxxxxxxxxxxxxxxxxxxxx'
>;>api=evalkitapiv1(url,token)
>;>projects=api.get撸projects().json()
>;>len(projects.json())\r子账户中的项目数
>;对于项目中的p。['resultlist']:
…print(p['id',p['title'])
…
49400测试评估a
57600测试评估b
````
api url和令牌应该如下:
``
evalkit_api_url=https://sub account.evaluationkit.com/api/v1
evalkit_api_token=xxxxxxxxxxxxxxxx thisxisxnotxaxrealxtokenxxxxxxxxxxxxxxxx
``
阅读
权限而不是环境变量,但请在这里忍受我。
一旦通过pip安装到项目中,使用如下:
`` python
from os import environ
from pprint import pprint
from evalkit_api_client.v1_client import evalkitapiv1
token=environ.get('evalkit_api_token')
api=evalkitapiv1(url,token)
projects=api.get projects()
print(projects.json())
````
\evalkitapiv1
"evalkitapiv1"客户端
对象需要"api-url"参数和"api-token"参数。"api-url"
应该在配置文件中定义,并且应该是没有端点的完整api
url,例如"https://sub.evaluationkit.com/api/v1/"。"api_token"
也应该在配置文件中定义,并且是为EvaluationKit中的给定子帐户生成的令牌。
有关详细信息,请参阅客户端界面[文档](文档)。
b列出车轮
测试:
pip uninstall evalkit_api_u client_echo"已卸载。"
pip install--无索引--查找链接=dist evalkit_api_client
通过指定指向`.whl`文件的完整或相对路径进行安装:
pip install--无索引/路径/to/canvas lms tools/evalkit_api_client/dist/evalkit_api_client-<;version>;-py2.py3 none any.whl
(如果要从另一个
项目安装,可能需要先"pip install wheel"。请参阅[堆栈溢出](https://stack overflow.com/questions/28002897/wheel file installation)
获取更多帮助。)
\sphinx docs
build/html/index.html
将文档部署到github页面:
git pull
git branch-d gh pages
git checkout-b gh pages
rm-rf./*
touch.nojekyll
git checkout master evalkit_api_client/docs/
<;按上述方式生成文档>;
mv evalkit_api_client/docs/build/html/*./
rm-rf evalkit_api_client
git add-a
git commit
git push-f origin gh pages
有关详细信息,请参阅[github pages documentation](https://pages.github.com/),
[斯芬克斯文档](http://www.sphinx-doc.org/en/master/contents.html)、
或以下[脚本文档](http://www.willmcginnis.com/2016/02/29/automating documentation workflow with sphinx and github pages/)。
以下"Cookiecutter"工具:
https://github.com/wdm0006/Cookiecutter pipproject
=
=
[综述]
[测试]
[测试]
[文档]
[文档]
[安装]
[安装]
[使用]
[使用]
[贡献]
[贡献]
[参考文献]
[综述]
[综述]
[综述]
[综述]
[综述]
[综述]
[安装]
[使用]
[使用]
[使用]
[贡献]
[贡献]
[贡献]
[贡献]
[参考文献]
[参考br/>——
用于向EvaluationKit API发出请求的库。
测试
----
此项目使用[tox]进行测试(https://tox.readthedocs.io/en/latest/)。
这个项目的tox运行:
*[flake8](http://flake8.pycqa.org/en/latest/)
*[mypy](http s://github.com/python/mypy)
*[pytest](https://docs.pytest.org/en/latest/)
创建测试覆盖率报告:
````
$tox-ecov
```
deployment
----
pypi的deployment使用tox:tox:网址:
https://lcary.github.io/canvas lms tools/
installation
----
使用pip:
pip install evalkit_api_client
或克隆repo:
python setup.py install
用法
----
您的项目的'requirements.txt`
文件是使用客户端的预期方式。
='xxxxxxxxxxxxxxxx thisxisxnotxaxrealxtokenxxxxxxxxxxxxxxxxxxxxxxx'
>;>api=evalkitapiv1(url,token)
>;>projects=api.get撸projects().json()
>;>len(projects.json())\r子账户中的项目数
>;对于项目中的p。['resultlist']:
…print(p['id',p['title'])
…
49400测试评估a
57600测试评估b
````
api url和令牌应该如下:
``
evalkit_api_url=https://sub account.evaluationkit.com/api/v1
evalkit_api_token=xxxxxxxxxxxxxxxx thisxisxnotxaxrealxtokenxxxxxxxxxxxxxxxx
``
阅读
权限而不是环境变量,但请在这里忍受我。
一旦通过pip安装到项目中,使用如下:
`` python
from os import environ
from pprint import pprint
from evalkit_api_client.v1_client import evalkitapiv1
api=evalkitapiv1(url,token)
projects=api.get projects()
print(projects.json())
````
\evalkitapiv1
"evalkitapiv1"客户端
对象需要"api-url"参数和"api-token"参数。"api-url"
应该在配置文件中定义,并且应该是没有端点的完整api
url,例如"https://sub.evaluationkit.com/api/v1/"。"api_token"
也应该在配置文件中定义,并且是为EvaluationKit中的给定子帐户生成的令牌。
有关详细信息,请参阅客户端界面[文档](文档)。
b列出车轮
测试:
pip uninstall evalkit_api_u client_echo"已卸载。"
pip install--无索引--查找链接=dist evalkit_api_client
通过指定指向`.whl`文件的完整或相对路径进行安装:
pip install--无索引/路径/to/canvas lms tools/evalkit_api_client/dist/evalkit_api_client-<;version>;-py2.py3 none any.whl
(如果要从另一个
项目安装,可能需要先"pip install wheel"。请参阅[堆栈溢出](https://stack overflow.com/questions/28002897/wheel file installation)
获取更多帮助。)
\sphinx docs
build/html/index.html
将文档部署到github页面:
git branch-d gh pages
git checkout-b gh pages
rm-rf./*
touch.nojekyll
git checkout master evalkit_api_client/docs/
<;按上述方式生成文档>;
mv evalkit_api_client/docs/build/html/*./
rm-rf evalkit_api_client
git add-a
git commit
git push-f origin gh pages
有关详细信息,请参阅[github pages documentation](https://pages.github.com/),
[斯芬克斯文档](http://www.sphinx-doc.org/en/master/contents.html)、
或以下[脚本文档](http://www.willmcginnis.com/2016/02/29/automating documentation workflow with sphinx and github pages/)。
以下"Cookiecutter"工具:
https://github.com/wdm0006/Cookiecutter pipproject