wims-adm/raw模块的python 3实现。

wimsapi的Python项目详细描述


构建状态codecoovcodfactordocumentation statuspypi versionpython 3.5+license mit>>>>

用于wims的adm/raw模块的python api

wims api是用python3编写的api,允许与wims进行通信 通过其adm/raw扩展服务器。

有关adm/raw的更多信息, 请参阅其文档

这里是wimsapi的文档

安装

最新的稳定版本可在pypi上获得。

pip install wimsapi

或者来源:

git clone https://github.com/qcoumes/wimsapi
cd wimsapi
python3 setup.py install

配置

全局配置

为了让wims接受来自wimsapi的请求, 必须在[wims\u home]/log/classes/.connections/中创建文件, 文件名将用作wimsapi的标识符名。

以下是此类文件的示例: [wims_home]/log/classes/.connections/myself

ident_site=172.17.0.1

ident_desc=This WIMS server

ident_agent=python-requests

# http / https.
ident_protocol=http

# password must be a word composed of alpha-numeric characters.
ident_password=toto

ident_type=json

# The address and identifier/password pair for calling back.
back_url=http://localhost/wims/wims.cgi
back_ident=myself
back_password=toto

以下是重要参数的说明:

  • 标识站点:允许向其发送请求的IP的空格分隔列表 WIMS服务器。
  • 标识代理必须设置为python请求
  • ident_password:在请求中与文件名一起用作标识符 在wims上进行身份验证
  • ident_type必须设置为json

上面的示例将允许IP172.17.0.1的计算机/服务器发送请求 到具有标识符我自己的和密码to towims服务器

类配置

如果您通过这个api创建了一个类,那么一切都应该正常工作。 怎么用?如果你想在已有的类中使用它 必须进行配置。

必须编辑文件[wims_home]/log/classes/[class_id]/.def并添加 文件末尾的这一行:

!set class_connections=+IDENT/RCLASS+

其中,ident是api使用的标识符(对应的 文件位于[wims\u home]/log/classes/.connections/中,如上所述)和 rclass是请求中发送的用于验证您自己身份的标识符 在课堂上。

基本上,要在wims服务器上的类上验证自己,您 需要:

  • url:指向wims的url(例如https://wims.unice.fr/wims/wims.cgi
  • ident:文件名位于[wims\u home]/log/classes/.connections/
  • passwd:中的ident_password的值 [wims_home]/log/classes/.connections/[ident]
  • rclass:在 [wims_home]/log/classes/[class_id]/.def

示例

fromwimsapiimportClass,Userc=Class.get("https://wims.unice.fr/wims/wims.cgi","myself","toto",9999,"myclass")c.institution="Another institution"# Modify class' institutionc.save()u=User.get(c,"qcoumes")u.email="coumes.quentin@gmail.com"# Modify user's emailu.save()new=User("quser","lastname","firstname","password","mail@mail.com")c.additem(new)# Add the new user to the class.

有关用法或示例的更多信息,请参见wimsapi的完整文档。

测试

要测试wimsapi,您需要一个正在运行的wims服务器。如果需要,您可以使用dockerfile快速设置一个dockerfile这里,按照自述文件步骤。

测试使用的默认url是http://localhost:7777/wims/wims.cgi,您可以使用环境变量wims-url覆盖它。例如:

WIMS_URL=http://mywims.com/wims/wims.cgi pytest

更改日志

0.5.2

0.5.1

0.5.0

0.4.1

0.4.0

0.3.9

0.3.7和0.3.8

0.3.6

0.3.5

0.3.4

0.3.3

0.3.2

0.3.1

0.3.0

0.2.2

0.2.1

0.2.0

0.1.0

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java如何在数据库中插入行时自动发送电子邮件?   从进程输出读取的Java问题   java质疑StyledDocument和JTextPane之间的关系,以及接口的正确使用   java错误getPlayer(args[0]);   java如何使Spring引导在重新打包的WAR中包含清单文件?   Java中的除法与模   java使用2d数组和JfreeChart制作散点图   java扩展SonarQube FindBugs插件和自定义FindBugs插件   javaspring:hibernate+ehcache   具有不正确的equals和HashCode实现的java HashMap   java Jaspersoft报告网。旧金山。jasperreports。发动机例外:net。旧金山。jasperreports。发动机填满JRepressionEvalException:计算表达式时出错   java如果输入与其变量不匹配,如何添加错误   在java中使用简单数组[]实现队列   无法启动上下文路径/hsx上的java FAIL应用程序