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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for chrome_extension_generator-0.0.2.tar.gz
Algorithm Hash digest
SHA256 f1a5018fef9b9a4db324034fe72c100e2ec4bf0aa6d0254df0723438bdc3eca2
MD5 5711b9c56f9c7bb851e8ae67303f828d
BLAKE2b-256 4848c5798e9aa4764fc197f1f54281535da24cdbd4c9cbf08a24967c575c96b4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for chrome_extension_generator-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1d6d129a739f5939c3c1bd75f1e9ee5483a5c16e10492e3a94ab2155b72dbb64
MD5 52a7aa8c72130d1b53ec26f451303e37
BLAKE2b-256 ede648f02601d76d35e1fcc475b185ce8ccd3eb3a5773583526f14f8b3dfe9df

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