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()

Metadata

Release files for taskbadger 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for taskbadger 0.2.1
File	Size	Uploaded
taskbadger-0.2.1.tar.gz	19.1 kB	Mar 6, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for taskbadger 0.2.1
File	Interpreter	ABI	Platform	Reset
taskbadger-0.2.1-py3-none-any.whl 41.9 kB Mar 6, 2023	Python 3	none	any	Details

Total release size: 61.0 kB

Release files / taskbadger-0.2.1.tar.gz

Download URL	taskbadger-0.2.1.tar.gz
Size	19.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`1d7f81bff9a152b074d161c6afc787c8bc9f25b7e8bbd39745d7db938dd8e30b`
BLAKE2b-256 checksum How to use checksums	`13e214a1d9e58e7d21a3404c9db568cd79743002d6304cd4beb45ee7d5a21d78`
Upload date	Mar 6, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.3.2 CPython/3.9.5 Linux/5.4.0-139-generic`

Release files / taskbadger-0.2.1-py3-none-any.whl

Download URL	taskbadger-0.2.1-py3-none-any.whl
Size	41.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`67a849f47f5b15db4365f32ae2e5b03f763076f6d7c9777391407e932f7f9539`
BLAKE2b-256 checksum How to use checksums	`91cf8095c2392f7e46ceaf51cd4cf04f54148a8130283d75141f7095607f7549`
Upload date	Mar 6, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.3.2 CPython/3.9.5 Linux/5.4.0-139-generic`