![[Latest Release Version]](https://pypi-camo.freetls.fastly.net/b96af15fdfb9721aa6c7fdc9f592380f35db9c75/68747470733a2f2f696d672e736869656c64732e696f2f707970692f762f776f726b66726f6e742d73646b2e737667)
SDK for managing Workfront tasks
Installation
Install via pip:
$ pip install workfront-sdkInstall from source:
$ git clone git://github.com/BridgeMarketing/workfront-sdk.git
$ cd workfront-sdk
$ python setup.py installExamples
How to create a Workfront Service object
Create the Workfront object and login:
>>> from workfront import Workfront
>>> wf = Workfront("ay.caramba@thebridgecorp.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:
>>> from workfront.objects import user
>>> user_by_email = user.from_email(wf, "ay.caramba@thebridgecorp.com")
>>> user_by_id = user.from_id(wf, "<WORKFRONT_USER_ID>")You can then access some fields of the users:
>>> 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 userHow to create and interact with a Task
Create the task by it’s workfront id and giving a Workfront service
>>> from workfront.objects.task import WFTask
>>> task = WFTask(wf, "<WF_TASK_ID>")Change the status of a task
>>> 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:
>>> from workfront.objects import user
>>> from workfront.objects.task import WFTask
>>> user_by_email = user.from_email(wf, "ay.caramba@thebridgecorp.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.
>>> 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:
>>> 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:
>>> from workfront.objects import project
>>> new_project = project.crt_from_template(wf, project_template_id, "NEW PROJECT NAME")
>>> new_project.wf_id
Release files for workfront-sdk 0.25
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| workfront-sdk-0.25.tar.gz | 21.0 kB | Details |
Release files / workfront-sdk-0.25.tar.gz
| Download URL | workfront-sdk-0.25.tar.gz |
|---|---|
| Size | 21.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1a6c98f0d35fc4b51d6cc23bf12c5aa35c8457711d25dc22fca6c43d96ad0852
|
|
BLAKE2b-256 checksum How to use checksums |
e94056f030f2da8e21c944f40a24114bfbcef1968a2f486375865eebf361b232
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Python-urllib/3.8
|
