Skip to main content

A quick way to generate the minimum boilerplate to start hacking on a chrome plugin.

Project description

chrome_extension_generator

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:

$ pip install git+https://github.com/radekosmulski/chrome_extension_generator.git

or from conda

$ conda install -c radekosmulski chrome_extension_generator

or from pypi

$ 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chrome_extension_generator-0.0.6.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chrome_extension_generator-0.0.6-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file chrome_extension_generator-0.0.6.tar.gz.

File metadata

File hashes

Hashes for chrome_extension_generator-0.0.6.tar.gz
Algorithm Hash digest
SHA256 7487a3947ef0275bbca1cc28b7dbe747989b87b01035a4aba458f7cb446246c0
MD5 dcaa4bc964c69dab17118ffd85b713b5
BLAKE2b-256 72a5e600e14328bdccd85d6bf48cd97f8b20d461d78bf0675ef64f2c692e13e0

See more details on using hashes here.

File details

Details for the file chrome_extension_generator-0.0.6-py3-none-any.whl.

File metadata

File hashes

Hashes for chrome_extension_generator-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 45f7a77f233712c7b914d8f125471fd399b95d5f988d20ae8f741408827ffd1b
MD5 91d122e403e4545ba8f3166e79d3bd10
BLAKE2b-256 e5bbc9907f4c4cafd254ac93e57607ee99b1ca5828b38e805619162723d56fb7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page