clickuphelper

Name	clickuphelper JSON
Version	0.3.9 JSON
	download
home_page	https://github.com/newmanrs/clickuphelper
Summary	Python classes, cli, and tooling to interact with Clickup
upload_time	2024-11-17 13:26:05
maintainer	None
docs_url	None
author	Richmond Newman
requires_python	>=3.6
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.
keywords	clickup api cli task management
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

# 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

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
```

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/newmanrs/clickuphelper",
    "name": "clickuphelper",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "clickup, api, cli, task management",
    "author": "Richmond Newman",
    "author_email": "Robert Newman <newmanrs@example.com>",
    "download_url": "https://files.pythonhosted.org/packages/10/f6/873409a4d4f4b33f69543901a6b792991bd8c42338d9145617c309d1f1b0/clickuphelper-0.3.9.tar.gz",
    "platform": null,
    "description": "# clickuphelper\n\nPython 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.\n\n## Environment Variables\n\nYou 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`\n\n## clickuptask\n\nCLI for working with single tasks\n`clickuptask --help`\n\n```\nUsage: clickuptask [OPTIONS] TASK_ID COMMAND [ARGS]...\n\n  Basic interface for probing clickup tasks. You must provide a task ID as\n  first argument. Default behaviour is to print the task json object.\n  Subcommands given afterwards be used to interact with the task object.\n\nOptions:\n  --help  Show this message and exit.\n\nCommands:\n  cf            Print custom field object\n  name          Print task name\n  post-comment  Post comment as whomevers credentials you are using\n  post-field    Post value to a custom field.\n  post-status   Post new task status\n  status        Print task status\n  subtasks      Display subtasks of task\n```\n\n## clickuplist\n\nFind and print information about lists\n\n```\nclickuplist --help\nUsage: clickuplist [OPTIONS] SPACE_NAME FOLDER_NAME LIST_NAME\n\nOptions:\n  -d, --display [list_id|list_obj|status_names|statuses|tasks|task_count]\n  --help                          Show this message and exit.\n```\n\nProvide FOLDER_NAME as empty string `''` if the list exists directly in a space.  Display options affect print output.\n\n## clickuptree\n\nPrints all spaces, folders, and lists available in the entire account.  Provide optional flags to include task ids as well.\n\n```\nUsage: clickuptree [OPTIONS]\n\nOptions:\n  -d, --display [no-tasks|tasks|subtasks]\n  --help                          Show this message and exit\n```\n",
    "bugtrack_url": null,
    "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. ",
    "summary": "Python classes, cli, and tooling to interact with Clickup",
    "version": "0.3.9",
    "project_urls": {
        "Bug Tracker": "https://github.com/newmanrs/clickuphelper/issues",
        "Homepage": "https://github.com/newmanrs/clickuphelper"
    },
    "split_keywords": [
        "clickup",
        " api",
        " cli",
        " task management"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2ba76b4973ca4209bcec615becaaaee4f950b3177a619246ef2c80ecfb3e4c1d",
                "md5": "9c7ed679686d38d46918cd3fa8ae70fc",
                "sha256": "e2acb3df024f32df98bd2cba1105a57cd661ebf2a6456417625871ee308fa2d8"
            },
            "downloads": -1,
            "filename": "clickuphelper-0.3.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9c7ed679686d38d46918cd3fa8ae70fc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 13324,
            "upload_time": "2024-11-17T13:26:03",
            "upload_time_iso_8601": "2024-11-17T13:26:03.981419Z",
            "url": "https://files.pythonhosted.org/packages/2b/a7/6b4973ca4209bcec615becaaaee4f950b3177a619246ef2c80ecfb3e4c1d/clickuphelper-0.3.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "10f6873409a4d4f4b33f69543901a6b792991bd8c42338d9145617c309d1f1b0",
                "md5": "3dc431a88a3d247a4ed122dc63c3e6fd",
                "sha256": "ffa85b4fe3ae151e2588d3c725825e6cececd4d0de8928d7416a9d3c4c3ebba8"
            },
            "downloads": -1,
            "filename": "clickuphelper-0.3.9.tar.gz",
            "has_sig": false,
            "md5_digest": "3dc431a88a3d247a4ed122dc63c3e6fd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 14039,
            "upload_time": "2024-11-17T13:26:05",
            "upload_time_iso_8601": "2024-11-17T13:26:05.545342Z",
            "url": "https://files.pythonhosted.org/packages/10/f6/873409a4d4f4b33f69543901a6b792991bd8c42338d9145617c309d1f1b0/clickuphelper-0.3.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-17 13:26:05",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "newmanrs",
    "github_project": "clickuphelper",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "clickuphelper"
}

Richmond Newman