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
Client Usage
Configuration
import taskbadger
taskbadger.init(
organization_slug="my-org",
project_slug="my-project",
token="***"
)
API Example
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()
CLI USage
Configuration
$ taskbadger configure
Organization slug: my-org
Project slug: project-x
API Key: XYZ.ABC
Config written to ~/.config/taskbadger/config
Usage Examples
The CLI run
command executes your command whilst creating and updating a Task Badger task.
$ taskbadger run "demo task" --action "error email to:me@test.com" -- path/to/script.sh
Task created: https://taskbadger.net/public/tasks/xyz/
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.4.4.tar.gz
(21.6 kB
view hashes)
Built Distribution
taskbadger-0.4.4-py3-none-any.whl
(46.2 kB
view hashes)
Close
Hashes for taskbadger-0.4.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c387ba4eb6e7af50cea23f2df61f74f514573d2a220e088a03f5d370945f29e8 |
|
MD5 | 9b45b74930614c63871a680dfc37107a |
|
BLAKE2b-256 | 7fe0a23876e819e9de92355e1de2d50410f4bbd4e37817a2a2a8096e9870c5ab |