Workfront for Python (SDK)
SDK for managing Workfront tasks
Installation
Install via pip:
$ pip install workfront-sdk
Install from source:
$ git clone git://github.com/BridgeMarketing/workfront-sdk.git
$ cd workfront-sdk
$ python setup.py install
Examples
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 user
How 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
Metadata
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 | Provenance | Actions |
|---|---|---|---|---|
| workfront-sdk-0.25.tar.gz | 21.0 kB | Without provenance | Details for workfront-sdk-0.25.tar.gz |
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
|
Security for workfront-sdk 0.25
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.