重写youtrack python api

YTClient的Python项目详细描述


ytclient-一个轻量级的youtrack rest api客户端,用于python

ytclient是一个轻量级http客户端,用于通过其rest api与jetbrain的youtrack问题跟踪程序交互。这是基于 稍微偏离原来的youtrack-rest-python-library,但是 与最初的项目不同,ytclient构建为与python 3兼容并使用YouTrack's new REST API 而不是原始项目当前使用的old REST API

应该注意,这个fork是为Tattler-Discord Issue Reporter创建的 当前版本只包含该项目所需的最小功能。外部附加功能 这个基本功能计划在ytclient的未来版本中实现。

兼容性

此客户端库和使用该库的导入脚本与Python3.6+兼容。不支持Python2.7。

此库支持任何支持新REST API的youtrack独立版本 以及YouTrack的当前版本。默认情况下,在所有youtrack安装中都启用rest api。

开始

此软件包已发布到pypi,可以与pip一起安装。

pip install YTClient

或者,您可以克隆此repo并运行setup.py。

setup.py install

身份验证

YTClient目前只支持对身份验证请求使用永久令牌。你可以生成你自己的永久 用户配置文件中的标记。有关说明,请参阅YouTrack documentation

fromYTClient.YTClientimportYTClient# authentication request with permanent tokenclient=YTClient('https://instance_name.myjetbrains.com/youtrack/',token='perm:abcdefghijklmn')

此请求要求指定目标YouTrack服务器的基URL。对于youtrack包含的实例,您的 基url包括后面的/youtrack,如前一个示例所示。

建立连接后,您的凭据将被缓存以用于后续请求。

您可以使用以下命令随时重置身份验证令牌:

client.set_auth_token()

支持的操作

目前YTClient只支持以下操作:

  • 创建问题-创建新问题
    • 参数
      • [req]项目-问题所属的项目
      • [req]摘要-问题的摘要行
      • [opt]说明-问题说明
      • [opt]附加字段-要设置的附加字段字典(注意:我在使其工作时遇到问题。我建议 现在使用run_命令设置其他字段。
      • [opt]return_fields-应随请求返回的字段列表。默认情况下会返回问题ID。
  • run_命令-运行youtrack命令
    • 参数
      • [req]命令-要运行的命令。使用包含要运行的命令的命名元组(在命令元组中指定为查询) 以及要运行命令的问题列表。
      • [opt]return_fields-应随请求返回的字段列表。默认情况下返回命令id。
  • get_问题-获取与指定查询匹配的问题列表
    • 参数
      • [req]查询-要使用的查询字符串
      • [opt]字段-应随请求返回的字段列表。默认情况下会返回问题ID。
      • [opt]跳过-要跳过的记录数
      • [opt]top-要返回的记录数
  • get_项目-获取所有项目的列表
    • 参数
      • [opt]字段-应随请求返回的字段列表。默认情况下返回项目id。
      • [opt]跳过-要跳过的记录数
      • [opt]top-要返回的记录数

欢迎加入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应用程序