workstreams
A Workstreams Python Client Library
For an overview of the Workstream API, click here.
Requirements
- Python >= 3.6
- Requests >= 2.19.0
Getting started
pip install workstreams
workstreams is very simple to use -- take a look at the below example:
from workstreams import WorkstreamsClient
workstreams = WorkstreamsClient('your token')
workstreams.tasks.create(team_id='T3T7BFHGV', channel_id='C3T7D66J1', ws_user_id='U3T716H3N', data={
'title': 'test task',
'labels': [
'init-labelid123'
],
'checklist': [{
'text': 'never gonna give you up',
'checked': False
}],
'dueDate': '2018-03-07T11:46:17Z',
'assignee': 'U3T716H3N'
})
Note: ws_user_id must always be provided for app tokens.
Tasks Resource (workstreams.tasks)
Available methods:
-
create(team_id, channel_id, data, ws_user_id=None)- Create a task -
update(task_id, data, ws_user_id=None)- Update a task -
fetch(task_id, ws_user_id=None)- Fetch a single task -
fetch_user_tasks(team_id, user_id, ws_user_id=None)- Fetch tasks for a single user -
fetch_tasks_for_users(team_id, user_ids, ws_user_id=None)- Fetch tasks for multiple users- Example:
fetch_tasks_for_users(team_id='T3T7BFHGV', user_ids=['U123456', 'U123457', 'U123458'], ws_user_id=None)
- Example:
-
fetch_tasks_for_channels(team_id, channel_ids)- Fetch all tasks for multiple channels- Example:
fetch_tasks_for_channels(team_id='T3T7BFHGV', channel_ids=['C3T7D66J1', 'C3T7D66J2'], ws_user_id=None)
- Example:
-
fetch_changed_tasks_for_channels(team_id, channel_ids, timestamp, ws_user_id=None)- Fetch all tasks for multiple channels which changed since given timestamp -
fetch_archived_tasks_for_channels(team_id, channel_ids, ws_user_id=None)- Fetch all archived tasks for multiple channels -
archive_tasks(task_ids, ws_user_id=None)- Archive multiple tasks -
restore_tasks(task_ids, ws_user_id=None)- Restore multiple tasks -
fetch_all_tasks_by_label(team_id, label_id, ws_user_id=None)- Fetch all tasks by label
Tasks Resource (workstreams.labels)
Available methods:
-
create(team_id, data, ws_user_id=None)- Create a new label -
update(label_id, data, ws_user_id=None)- Update a label -
delete(label_id, ws_user_id=None)- Delete a label -
fetch(label_id, ws_user_id=None)- Fetch a single label -
fetch_team_labels(team_id, ws_user_id=None)- Fetch all labels for a given team
Goals Resource (workstreams.goals)
Available methods:
-
create(team_id, data, ws_user_id=None)- Create a new goal -
update(team_id, goal_id, data, ws_user_id=None)- Update a goal -
archive(team_id, goal_id, ws_user_id=None)- Archive a goal -
fetch_all(team_id, ws_user_id=None)- Fetch all goals visible to the token owner
Contributions
TBD
Bug Reports
TBD
Metadata
Release files for workstreams 1.0.6
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 |
|---|---|---|---|---|
| workstreams-1.0.6.tar.gz | 4.3 kB | Without provenance | Details for workstreams-1.0.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| workstreams-1.0.6-py3-none-any.whl | Python 3 | none | any | Details for workstreams-1.0.6-py3-none-any.whl |
Total release size: 15.2 kB
Release files / workstreams-1.0.6.tar.gz
| Download URL | workstreams-1.0.6.tar.gz |
|---|---|
| Size | 4.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9a4643f4a6b7f18e4f55ed4a2085091f3e84e0d35711bc675afedacab9776baa
|
|
BLAKE2b-256 checksum How to use checksums |
580464b5f7e0af097ff54adecf86ccf13f034e0e1412fa22e873d30ef334549f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3
|
Release files / workstreams-1.0.6-py3-none-any.whl
| Download URL | workstreams-1.0.6-py3-none-any.whl |
|---|---|
| Size | 10.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1d9f2d0eb2db314b25d40800b6b0aaf11cdd0de5ea726d00e2acaabd1475bd08
|
|
BLAKE2b-256 checksum How to use checksums |
b17adbb7b3135350810083aa924e31b61fbb1351334d382e0374b4a9a46255df
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3
|
Security for workstreams 1.0.6
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.