Metadata-Version: 1.1
Name: pyzentao
Version: 0.2.1
Summary: Python SDK for Zentao.
Home-page: https://github.com/philip1134/pyzentao
Author: Philip CHAN
Author-email: philip1134@imior.com
License: MIT
Description: ========
        pyzentao
        ========
        
        .. image:: https://travis-ci.com/philip1134/pyzentao.svg?branch=master
           :target: https://travis-ci.com/philip1134/pyzentao
           :alt: Build Status
        
        .. image:: https://img.shields.io/pypi/v/pyzentao.svg?color=orange
           :target: https://pypi.python.org/pypi/pyzentao
           :alt: PyPI Version
        
        .. image:: https://img.shields.io/pypi/pyversions/pyzentao.svg
           :target: https://pypi.org/project/pyzentao/
           :alt: Supported Python versions
        
        ``pyzentao`` 是禅道API的Python SDK，简单封装了禅道API，将其映射成为Python方法，例如：
        
        .. code:: text
        
            GET  /zentao/user-task-[userID]-[type]-[recTotal]-[recPerPage]-[pageID].json
        
        被映射成为 ``Zentao.user_task(...)`` ，后续 ``[...]`` 里的参数被映射成为调用方法的参数。
        
        在调用方法时，``pyzentao`` 会根据初始化时输入的配置参数获取禅道的授权，然后调用对应的API，并返回原生的数据结果。
        
        
        Installation
        ------------
        
        .. code:: text
        
            $ pip install -U pyzentao
        
        Usage
        -----
        
        举个栗子，要获取指定用户的任务，原生API为：
        
        .. code:: text
        
            GET  /zentao/user-task-[userID]-[type]-[recTotal]-[recPerPage]-[pageID].json
        
        该API被映射为 ``user_task`` 方法：
        
        .. code:: python
        
            import pyzentao
        
            zentao = pyzentao.Zentao(
                "url": "http://my.zentao.site/namespace",
                "version": "15",
                "username": "admin",
                "password": "123456",
            )
        
            tasks = zentao.user_task(
                userID=1,
                type="finishedBy",
                ...
            )
        
            print(tasks.status) # success
            print(tasks.data) # dict...
        
        
        初始化 ``Zentao`` 对象时的参数说明如下：
        
        .. code:: text
        
            url: 禅道站点的域名
            version: 禅道版本号，不同的禅道版本其API格式不同
            username: 登录禅道的帐号用户名，该帐号最好具有管理员权限
            password: 登录禅道的帐号密码
            spec:   自定义的API规则，选填
                path: 存放自定义规则的路径或者文件路径，须为yaml文件
                merge: 合并方式，True 表示与默认规则合并
        
        
Keywords: Python SDK
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Testing
