clickup-to-sqlite icon indicating copy to clipboard operation
clickup-to-sqlite copied to clipboard

clickup-to-sqlite

PyPI Changelog Tests License

Save data from ClickUp to a SQLite database.

Currently to CLI tool collects the following data from ClickUp:

  • Teams
  • Spaces
  • Lists
  • Folders
  • Tasks
  • Time entries

The following data is currently not yet downloaded:

  • Comments
  • Goals
  • Guests
  • Member data
  • Views

How to install

$ pip install clickup-to-sqlite

Authentication

First, you will need to get your personal access token from ClickUp. Retrieve it from ClickUp under Settings > My Apps > Apps > API Token. Then use the value with the --auth-token option like explained below or provide it with the CLICKUP_ACCESS_TOKEN environment variable. This works especially well when using something like direnv.

Usage

To download your ClickUp data into a sqlite database run the following command:

$ clickup-to-sqlite fetch --access-token=pk_YOUR_PERSONAL_TOKEN clickup.sqlite

Note: Currently the data fetching will run into the rate limit applied by the ClickUp API if your backlog of tasks or time entries is rather large.

Once you have downloaded the data into the sqlite database, you can explore the data. I recommend to have a look at Datasette for adhoc analysis.