# chrome_extension_generator
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
A command-line tool to streamline the creation of Chrome extensions by
automatically generating the required boilerplate files.
## Why?
Chrome extensions are powerful tools for customizing your browsing
experience, but setting up the basic structure can be repetitive. This
tool was created to eliminate the tedious part of:
- Creating the correct directory structure
- Writing a basic manifest.json with proper Chrome Extension v3 format
- Setting up initial content scripts
- Creating documentation
By automating these common tasks, developers can focus on what matters:
implementing their extension’s actual functionality.
## Installation
Install latest from the GitHub
[repository](https://github.com/radekosmulski/chrome_extension_generator):
``` sh
$ pip install git+https://github.com/radekosmulski/chrome_extension_generator.git
```
or from
[conda](https://anaconda.org/radekosmulski/chrome_extension_generator)
``` sh
$ conda install -c radekosmulski chrome_extension_generator
```
or from [pypi](https://pypi.org/project/chrome_extension_generator/)
``` sh
$ pip install chrome_extension_generator
```
## Usage
### Command Line Interface
After installation, you can use the command line tool directly:
chrome-extension-generate --name "My Extension" --desc "A cool extension" --url "https://example.com/*"
### Python API
You can also use it programmatically in your Python code:
from chrome_extension_generator.core import main
### Parameters
--name Name of your extension (required)
--desc Short description of what your extension does (optional)
--url URL pattern where your extension will run (optional)
--repo GitHub repository URL (optional)
## Output Structure
your-extension-name/
├── README.md
├── manifest.json
└── content.js
Each file is pre-populated with the provided information and formatted
for easy reading and editing.
Raw data
{
"_id": null,
"home_page": "https://github.com/radekosmulski/chrome_extension_generator",
"name": "chrome-extension-generator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "nbdev jupyter notebook python",
"author": "Radek Osmulski",
"author_email": "rosmulski@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/72/a5/e600e14328bdccd85d6bf48cd97f8b20d461d78bf0675ef64f2c692e13e0/chrome_extension_generator-0.0.6.tar.gz",
"platform": null,
"description": "# chrome_extension_generator\n\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\nA command-line tool to streamline the creation of Chrome extensions by\nautomatically generating the required boilerplate files.\n\n## Why?\n\nChrome extensions are powerful tools for customizing your browsing\nexperience, but setting up the basic structure can be repetitive. This\ntool was created to eliminate the tedious part of:\n\n- Creating the correct directory structure\n- Writing a basic manifest.json with proper Chrome Extension v3 format\n- Setting up initial content scripts\n- Creating documentation\n\nBy automating these common tasks, developers can focus on what matters:\nimplementing their extension\u2019s actual functionality.\n\n## Installation\n\nInstall latest from the GitHub\n[repository](https://github.com/radekosmulski/chrome_extension_generator):\n\n``` sh\n$ pip install git+https://github.com/radekosmulski/chrome_extension_generator.git\n```\n\nor from\n[conda](https://anaconda.org/radekosmulski/chrome_extension_generator)\n\n``` sh\n$ conda install -c radekosmulski chrome_extension_generator\n```\n\nor from [pypi](https://pypi.org/project/chrome_extension_generator/)\n\n``` sh\n$ pip install chrome_extension_generator\n```\n\n## Usage\n\n### Command Line Interface\n\nAfter installation, you can use the command line tool directly:\n\n chrome-extension-generate --name \"My Extension\" --desc \"A cool extension\" --url \"https://example.com/*\"\n\n### Python API\n\nYou can also use it programmatically in your Python code:\n\n from chrome_extension_generator.core import main\n\n### Parameters\n\n --name Name of your extension (required)\n --desc Short description of what your extension does (optional)\n --url URL pattern where your extension will run (optional)\n --repo GitHub repository URL (optional)\n\n## Output Structure\n\n your-extension-name/\n \u251c\u2500\u2500 README.md\n \u251c\u2500\u2500 manifest.json\n \u2514\u2500\u2500 content.js\n\nEach file is pre-populated with the provided information and formatted\nfor easy reading and editing.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "A quick way to generate the minimum boilerplate to start hacking on a chrome plugin.",
"version": "0.0.6",
"project_urls": {
"Homepage": "https://github.com/radekosmulski/chrome_extension_generator"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e5bbc9907f4c4cafd254ac93e57607ee99b1ca5828b38e805619162723d56fb7",
"md5": "91d122e403e4545ba8f3166e79d3bd10",
"sha256": "45f7a77f233712c7b914d8f125471fd399b95d5f988d20ae8f741408827ffd1b"
},
"downloads": -1,
"filename": "chrome_extension_generator-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "91d122e403e4545ba8f3166e79d3bd10",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 8825,
"upload_time": "2025-01-16T00:38:33",
"upload_time_iso_8601": "2025-01-16T00:38:33.698946Z",
"url": "https://files.pythonhosted.org/packages/e5/bb/c9907f4c4cafd254ac93e57607ee99b1ca5828b38e805619162723d56fb7/chrome_extension_generator-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "72a5e600e14328bdccd85d6bf48cd97f8b20d461d78bf0675ef64f2c692e13e0",
"md5": "dcaa4bc964c69dab17118ffd85b713b5",
"sha256": "7487a3947ef0275bbca1cc28b7dbe747989b87b01035a4aba458f7cb446246c0"
},
"downloads": -1,
"filename": "chrome_extension_generator-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "dcaa4bc964c69dab17118ffd85b713b5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9128,
"upload_time": "2025-01-16T00:38:37",
"upload_time_iso_8601": "2025-01-16T00:38:37.380615Z",
"url": "https://files.pythonhosted.org/packages/72/a5/e600e14328bdccd85d6bf48cd97f8b20d461d78bf0675ef64f2c692e13e0/chrome_extension_generator-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-16 00:38:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "radekosmulski",
"github_project": "chrome_extension_generator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "chrome-extension-generator"
}
JSON
