Clockify/Clockify_Delete_project.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "3e6082c8-f297-480b-b50a-924fcc79e7db",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "<img width=\"8%\" alt=\"Clockify.png\" src=\"https://raw.githubusercontent.com/jupyter-naas/awesome-notebooks/master/.github/assets/logos/Clockify.png\" style=\"border-radius: 15%\">"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "f0a21752-7632-4070-af0a-e5497291e93c",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "# Clockify - Delete project\n",
    "<a href=\"https://bit.ly/3JyWIk6\">Give Feedback</a> | <a href=\"https://github.com/jupyter-naas/awesome-notebooks/issues/new?assignees=&labels=bug&template=bug_report.md&title=Clockify+-+Delete+project:+Error+short+description\">Bug report</a>"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "af72a081-1b22-4e4b-a2bc-571ebc200bb3",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**Tags:** #clockify #project #create #api #rest #documentation"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "63728e67-4ac9-43b8-a0db-36cd95a1acf6",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**Author:** [Florent Ravenel](https://www.linkedin.com/in/florent-ravenel/)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "bf022038-4835-4c63-968e-90e393ca2ad1",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**Last update:** 2023-05-17 (Created: 2023-05-17)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "3422944e-43e0-437a-bacb-75f5a4c06962",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**Description:** This notebook will show how to delete an existing project using Clockify API from a specific workspace. You can only delete archived project. Active project can not be deleted."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "7cd59fdf-9792-496d-8caa-1dfe5bf2c415",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**References:**\n",
    "- [Clockify API Documentation](https://docs.clockify.me/#tag/Project/operation/delete_6)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "8308e804-f91c-4554-b242-8cb5903bd0ef",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "## Input"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "b8e83785-9586-44b9-ba36-70c196faa64a",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "### Import libraries"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "74239d79-d9a0-4d95-ba2e-c1c2814fc45d",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": [
    "import requests\n",
    "import naas"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "d9f2b66c-f690-4418-96cf-1d940f61f4f6",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "### Setup Variables\n",
    "- `api_key`: [Get your API key](https://clockify.me/user/settings)\n",
    "- `workspace_id`: ID of the workspace\n",
    "- `project_id`: ID of the project to be deleted"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "8fdb24cb-8602-4f08-93d0-30b9b19bf34a",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": [
    "api_key = naas.secret.get(\"CLOCKIFY_API_KEY\") or \"YOUR_API_KEY\"\n",
    "workspace_id = \"626f9e3b36c2670314c0386e\" #\"<WORKSPACE_ID>\"\n",
    "project_id = \"6465128cb3aa2432050af887\""
   ]
  },
  {
   "cell_type": "markdown",
   "id": "f1a41e64-837d-425d-9b4e-98c24cfc1ff3",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "## Model"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "99daad44-44b0-4732-894f-64438dae77fb",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "### Delete project"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "d4241b6c-27ef-460f-9cb2-4e7626714bcf",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "This function will delete an existing project using Clockify API."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "467e55ba-2064-4991-8b73-c16b4d415535",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": [
    "def delete_project(api_key, workspace_id, project_id):\n",
    "    url = f\"https://api.clockify.me/api/workspaces/{workspace_id}/projects/{project_id}\"\n",
    "    headers = {\n",
    "        \"X-Api-Key\": api_key,\n",
    "        \"Content-Type\": \"application/json\"\n",
    "    }\n",
    "    response = requests.delete(url, headers=headers)\n",
    "    return response"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "d11454d0-acff-4436-a8d9-355b2ff3c82d",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "## Output"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "ea34bbcf-bb92-4863-9c90-8b364bd0ac93",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "### Display result"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "3faa8d4b-993c-4405-ac83-7ccfc7ad4e9a",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": [
    "response = delete_project(api_key, workspace_id, project_id)\n",
    "if response.status_code == 200:\n",
    "    print(f\"✅ Client '{project_id}' deleted from workspace\")\n",
    "else:\n",
    "    print(f\"❌ Error while deleted project '{project_id}'\")\n",
    "response.json()"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "b5bf388a-df43-4296-8c38-26e32efad20e",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    " "
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.9.6"
  },
  "naas": {
   "notebook_id": "d57352246f90d2636fbe59bbd56770cd15f64252f8f7f9d0495f907809369af8",
   "notebook_path": "Clockify/Clockify_Delete_project.ipynb"
  },
  "papermill": {
   "default_parameters": {},
   "environment_variables": {},
   "parameters": {},
   "version": "2.4.0"
  },
  "widgets": {
   "application/vnd.jupyter.widget-state+json": {
    "state": {},
    "version_major": 2,
    "version_minor": 0
   }
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}