-
Notifications
You must be signed in to change notification settings - Fork 0
/
PKG-INFO
134 lines (89 loc) · 4.36 KB
/
PKG-INFO
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
Metadata-Version: 1.0
Name: workfront-sdk
Version: 0.22.1
Summary: Workfront for Python (SDK)
Home-page: https://github.com/BridgeMarketing/workfront-sdk
Author: Bridge
Author-email: info@bridgecorp.com
License: GPL
Description: Workfront for Python (SDK)
==========================
.. image:: https://img.shields.io/pypi/v/workfront-sdk.svg
:target: https://pypi.python.org/pypi/workfront-sdk
:alt: [Latest Release Version]
SDK for managing Workfront tasks
Installation
------------
Install via ``pip``:
.. code-block:: console
$ pip install workfront-sdk
Install from source:
.. code-block:: console
$ git clone https://github.com/leqnam/workfront-sdk-pymod.git
$ cd workfront-sdk
$ python setup.py install
Examples
--------
How to create a Workfront Service object
----------------------------------------
Create the Workfront object and login:
.. code-block:: pycon
>>> from workfront import Workfront
>>> wf = Workfront("your_email@your_company.com", "1234wfpass")
>>> wf.login()
Then you can use it.
How to create a user object
---------------------------
With a Workfront service object, you can create a user by email or by id:
.. code-block:: pycon
>>> from workfront.objects import user
>>> user_by_email = user.from_email(wf, "your_email@your_company.com")
>>> user_by_id = user.from_id(wf, "<WORKFRONT_USER_ID>")
You can then access some fields of the users:
.. code-block:: pycon
>>> print user_by_email.wf_id # print the workfront id
>>> print user_by_email.name # print the name of the user
>>> print user_by_email.emailAddr # print the email of the user
How to create and interact with a Task
--------------------------------------
Create the task by it's workfront id and giving a Workfront service
.. code-block:: pycon
>>> from workfront.objects.task import WFTask
>>> task = WFTask(wf, "<WF_TASK_ID>")
Change the status of a task
---------------------------
.. code-block:: pycon
>>> from workfront.objects.status import WFTaskStatus
>>> task.set_status(WFTaskStatus.in_progress)
Assign a task to a different user
---------------------------------
Once you have a WF user and a task you can:
.. code-block:: pycon
>>> from workfront.objects import user
>>> from workfront.objects.task import WFTask
>>> user_by_email = user.from_email(wf, "your_email@your_company.com")
>>> task = WFTask(wf, "<WF_TASK_ID>")
>>> task.assign_to_user(user_by_email)
Get and set custom fields
-------------------------
You can use the methods **set_param_values** and **get_param_values** to modify and access task custom fields.
.. code-block:: pycon
>>> task = WFTask(wf, "<WF_TASK_ID>")
>>> task.get_param_values()
>>> {"custom_field": "value", "list_field": ["value1", "value2"]}
>>> task.set_param_values({"custom_field": "other_value"})
>>> task.get_param_values()
>>> {"custom_field": "other_value", "list_field": ["value1", "value2"]}
How to use projects
-------------------
You can load a project from the id, and access the template id:
.. code-block:: pycon
>>> from workfront.objects import project
>>> p = project.WFProject(wf, "<WF_PROJECT_ID>")
>>> project_template_id = p.get_template_id()
With the template id, you can create another project:
.. code-block:: pycon
>>> from workfront.objects import project
>>> new_project = project.crt_from_template(wf, project_template_id, "NEW PROJECT NAME")
>>> new_project.wf_id
Platform: UNKNOWN