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.4.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.4-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for chrome_extension_generator-0.0.4.tar.gz
Algorithm Hash digest
SHA256 ebe062220c941f3bf7eae86cb906bd0df9dec4cfd61cd13ea3b8af0e6fc38924
MD5 c18ab3a8dbae65cebb1d4d5b2900c6bd
BLAKE2b-256 82c4cae63e55a8354c7200233d2c8eb8195b705d8a6b1c4cb33df5fa8e0fb33d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for chrome_extension_generator-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f06021165cc14b2c155068ae8431b9a54bf51a9239d81cc5517463c3f9ad50db
MD5 a3ceab28ae7d9c78b7db370bc2ab014e
BLAKE2b-256 8f9f43783d8f7c75dfed1478a2d4144b2cd4fe093768f41d4fdb7ae7458775f9

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