{"id":16077869,"url":"https://github.com/jupyterlab/extension-cookiecutter-ts","last_synced_at":"2025-10-23T23:53:37.432Z","repository":{"id":11327123,"uuid":"69312752","full_name":"jupyterlab/extension-cookiecutter-ts","owner":"jupyterlab","description":"A cookiecutter recipe for JupyterLab extensions in Typescript","archived":false,"fork":false,"pushed_at":"2024-09-03T21:16:14.000Z","size":359,"stargazers_count":183,"open_issues_count":10,"forks_count":88,"subscribers_count":19,"default_branch":"4.0","last_synced_at":"2025-01-11T15:41:28.881Z","etag":null,"topics":["cookiecutter","jupyterlab","jupyterlab-extension","typescript"],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jupyterlab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"numfocus","custom":"https://numfocus.org/donate-to-jupyter"}},"created_at":"2016-09-27T02:45:42.000Z","updated_at":"2024-11-08T04:52:09.000Z","dependencies_parsed_at":"2023-02-19T08:46:35.537Z","dependency_job_id":"5dbc09b4-4eab-4024-87e5-c2bcd0c0183d","html_url":"https://github.com/jupyterlab/extension-cookiecutter-ts","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jupyterlab%2Fextension-cookiecutter-ts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jupyterlab%2Fextension-cookiecutter-ts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jupyterlab%2Fextension-cookiecutter-ts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jupyterlab%2Fextension-cookiecutter-ts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jupyterlab","download_url":"https://codeload.github.com/jupyterlab/extension-cookiecutter-ts/tar.gz/refs/heads/4.0","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237739846,"owners_count":19358624,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cookiecutter","jupyterlab","jupyterlab-extension","typescript"],"created_at":"2024-10-09T10:04:33.596Z","updated_at":"2025-10-22T20:30:45.263Z","avatar_url":"https://github.com/jupyterlab.png","language":"CSS","funding_links":["https://github.com/sponsors/numfocus","https://numfocus.org/donate-to-jupyter"],"categories":["typescript","Data Science and ML"],"sub_categories":["Cookiecutter Templates"],"readme":"# JupyterLab extension-cookiecutter-ts\n\n[![Github Actions Status](https://github.com/jupyterlab/extension-cookiecutter-ts/workflows/CI/badge.svg)](https://github.com/jupyterlab/extension-cookiecutter-ts/actions/workflows/main.yml)\n\n⚠️ **We strongly advice to use the template next generation: https://github.com/jupyterlab/extension-template**\n\nA [cookiecutter](https://github.com/audreyr/cookiecutter) template for creating\na JupyterLab extension. Three kinds of extension are supported:\n- _frontend_: Pure frontend extension written in TypeScript.\n- _server_: Extension with frontend (in TypeScript) and backend (in Python) parts.\n- _theme_: Theme for JupyterLab (using CSS variables).\n    \n\u003e See also [extension-cookiecutter-js](https://github.com/jupyterlab/extension-cookiecutter-js)\nfor an extension in CommonJS.\n\n## Use the template to create package\n\nInstall cookiecutter.\n\n```\npip install cookiecutter\n```\n\nUse cookiecutter to generate a package, following the prompts to fill in the name and authorship of your new JupyterLab extension.\n\n```\ncookiecutter https://github.com/jupyterlab/extension-cookiecutter-ts --checkout 4.0\n```\n\nThe available options are:\n\n- `kind`:\n  * frontend --\u003e Extension has only a frontend (TypeScript + CSS) part\n  * server --\u003e Extension has frontend and backend (new Python endpoint handlers for the server) parts\n  * theme --\u003e Extension provides a new theme (and nothing else)\n- `author_name`: The extension author name\n- `author_email`: The extension author email\n- `labextension_name`: Extension name\n- `python_name`: Pythonic extension name (if your extension has no server part, it will only be used to distribute the extension as a Python package)\n- `project_short_description`: Extension short description\n- `has_settings`: Whether the extension will have user settings or not.\n- `has_binder`: Whether to set up [binder](https://mybinder.readthedocs.io/en/latest/) for the extension or not.\n- `test`: Whether to add test set ups and skeletons for the extension or not\n- `repository`: Version Control System repository URI\n\n\nIf you'd like to generate a package for a specific JupyterLab release, use the `--checkout` option and give a tag or commit from this repository.\n\n```\ncookiecutter https://github.com/jupyterlab/extension-cookiecutter-ts --checkout v1.0\ncookiecutter https://github.com/jupyterlab/extension-cookiecutter-ts --checkout v2.0\ncookiecutter https://github.com/jupyterlab/extension-cookiecutter-ts --checkout 3.0\n```\n\n## A simple example\n\nYour new extension includes a very simple example of a working extension. Use this example as a guide to build your own extension. Have a look at the [extension examples](https://github.com/jupyterlab/extension-examples) repository for more information on various JupyterLab features.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjupyterlab%2Fextension-cookiecutter-ts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjupyterlab%2Fextension-cookiecutter-ts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjupyterlab%2Fextension-cookiecutter-ts/lists"}