Skip to content

the-trybe/clickup-automation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ClickUp Task Explorer

A Streamlit application to explore and visualize tasks from your ClickUp workspaces.

Features

  • Browse through your Teams, Spaces, Folders, and Lists.
  • View tasks in a selected Team, Space, or List.
  • Display key task details like assignee, priority, due date, and status.
  • Export tasks to Excel or CSV.
  • Visualize task statistics and alerts.

Installation

Prerequisites

  • Python 3.10+
  • Pip

Steps

  1. Clone the repository:

    git clone https://github.com/your-username/click-up-automation.git
    cd click-up-automation
  2. Create and activate a virtual environment:

    python -m venv venv
    source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
  3. Install the dependencies:

    pip install -r requirements.txt

Configuration

  1. Create a .env file:

    Create a .env file in the root of the project by copying the example file:

    cp .env.example .env
  2. Set your ClickUp API token:

    Open the .env file and add your ClickUp API token:

    CLICKUP_API_TOKEN=your_clickup_api_token
    

    You can create a new token in your ClickUp settings under "Apps". To do this, go to your workspace settings, then to the "Apps" section to generate a new token.

Usage

Running the application locally

Once you have installed the dependencies and configured your API token, you can run the application with Streamlit:

streamlit run app.py

The application will be available at http://localhost:8501.

Running with Docker

Alternatively, you can run the application using Docker and Docker Compose.

  1. Build and run the container:

    docker-compose up --build
  2. Access the application:

    The application will be available at http://localhost:8501.

Project Structure

.
├── .env.example
├── .gitignore
├── app.py
├── docker-compose.yml
├── Dockerfile
├── README.md
├── requirements.txt
└── src
    ├── clickup_api.py
    ├── data_processing.py
    ├── ui.py
    ├── utils.py
    └── components
        ├── alerts.py
        └── stats.py

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published