Metadata-Version: 2.4
Name: clickuphelper
Version: 0.5.0
Summary: Python classes, cli, and tooling to interact with Clickup
Home-page: https://github.com/newmanrs/clickuphelper
Author: Richmond Newman
Author-email: Robert Newman <newmanrs@example.com>
License: MIT License
        
        Copyright (c) 2021 Richmond Newman
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/newmanrs/clickuphelper
Project-URL: Bug Tracker, https://github.com/newmanrs/clickuphelper/issues
Keywords: clickup,api,cli,task management
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Requires-Dist: requests
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# 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](https://help.clickup.com/hc/en-us/articles/6303426241687-Getting-Started-with-the-ClickUp-API#personal-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
```
