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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for chrome_extension_generator-0.0.3.tar.gz
Algorithm Hash digest
SHA256 97011c543332ccf3eca96ebc0755605db8c0cc0e6b785dab356422063bfa506a
MD5 fd547970a971a2fafda645ca7bb62118
BLAKE2b-256 6e62d9f8d34ce7d4438f5673f47aaad8b71d9cdb7108d712bda05d06de79c8c1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for chrome_extension_generator-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 87d5d2b0f83059c19463b96f792a618801822343d2f1e90b1d06320f7238d65a
MD5 f8e15b01c8d09c11f8d31cd244b80c7b
BLAKE2b-256 aca5e233ea186d95cc8e9da58fda8c0580ceb9c30f05ec3d51071e565c11da48

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