Skip to main content

A CLI tool for interacting with ClickUp

Project description

clickuphelper

Python classes, cli, and tooling to interact with Clickup. Install with git+https, setup.py or make. Install creates a few handy cli utilities for itneracting with clickup.

Environment Variables

You will need to provide your clickup team id and a clickup api key. Place them in the variables CLICKUP_TEAM_ID, CLICKUP_API_KEY

clickuptask

CLI for working with single tasks clickuptask --help

Usage: clickuptask [OPTIONS] TASK_ID COMMAND [ARGS]...

  Basic interface for probing clickup tasks. You must provide a task ID as
  first argument. Default behaviour is to print the task json object.
  Subcommands given afterwards be used to interact with the task object.

Options:
  --help  Show this message and exit.

Commands:
  cf            Print custom field object
  name          Print task name
  post-comment  Post comment as whomevers credentials you are using
  post-field    Post value to a custom field.
  post-status   Post new task status
  status        Print task status
  subtasks      Display subtasks of task

clickuplist

Find and print information about lists

clickuplist --help
Usage: clickuplist [OPTIONS] SPACE_NAME FOLDER_NAME LIST_NAME

Options:
  -d, --display [list_id|list_obj|status_names|statuses|tasks|task_count]
  --help                          Show this message and exit.

Provide FOLDER_NAME as empty string '' if the list exists directly in a space. Display options affect print output.

clickuptree

Prints all spaces, folders, and lists available in the entire account. Provide optional flags to include task ids as well.

Usage: clickuptree [OPTIONS]

Options:
  -d, --display [no-tasks|tasks|subtasks]
  --help                          Show this message and exit

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clickuphelper-0.3.6.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

clickuphelper-0.3.6-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file clickuphelper-0.3.6.tar.gz.

File metadata

  • Download URL: clickuphelper-0.3.6.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for clickuphelper-0.3.6.tar.gz
Algorithm Hash digest
SHA256 a0e32cb351f6261c9300be1a4ec940c324b31a9e464735c9836278a87172e6ba
MD5 cc14bc89614c6f0b95fe3edd685563fc
BLAKE2b-256 8f52fd1d28ba6c02da0ef1a47d29c2f772c396fbf451d977551b6af89b47cf2c

See more details on using hashes here.

File details

Details for the file clickuphelper-0.3.6-py3-none-any.whl.

File metadata

File hashes

Hashes for clickuphelper-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e2f9a4d36b9d547541a492c96bf6d1c12f2c0aa6f941c32e9f01d24e2c675a8d
MD5 97f1422a3591527ce87cec0ec73d3881
BLAKE2b-256 578f8f6c0881fb9e281854bacb5925ed29617c8400ab57ece25b549dfbb966c8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page