The official Python SDK for Task Badger
Project description
Task Badger Python Client
This is the official Python SDK for Task Badger.
For full documentation go to https://docs.taskbadger.net/python/.
Getting Started
Install
pip install --upgrade taskbadger
Configuration
import taskbadger
taskbadger.init(
organization_slug="my-org",
project_slug="my-project",
token="***"
)
Usage
from taskbadger import Task, Action, EmailIntegration
# create a new task with custom data and an action definition
task = Task.create(
"task name",
data={
"custom": "data"
},
actions=[
Action(
"*/10%,success,error",
integration=EmailIntegration(to="me@example.com")
)
]
)
# update the task status to 'processing' and set the value to 0
task.started()
try:
for i in range(100):
do_something(i)
if i!= 0 and i % 10 == 0:
# update the progress of the task
task.update_progress(i)
except Exception as e:
# record task errors
task.error(data={
"error": str(e)
})
raise
# record task success
task.success()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
taskbadger-0.2.1.tar.gz
(19.1 kB
view hashes)
Built Distribution
taskbadger-0.2.1-py3-none-any.whl
(41.9 kB
view hashes)
Close
Hashes for taskbadger-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67a849f47f5b15db4365f32ae2e5b03f763076f6d7c9777391407e932f7f9539 |
|
MD5 | d378b96a651acf76095466aa76904365 |
|
BLAKE2b-256 | 91cf8095c2392f7e46ceaf51cd4cf04f54148a8130283d75141f7095607f7549 |