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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for chrome_extension_generator-0.0.5.tar.gz
Algorithm Hash digest
SHA256 dfaa1d6dd9f08c6cd0c2c11598e2aa6e2bd87207e9859fe22fb0e1e89c4bf939
MD5 3c8ad84a2fd6c809232a1a15fdf7acc3
BLAKE2b-256 7dc95dbe7631c1de8ba1c64535b544dc3ae78a302ba724369b8f6f43d4ec889f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for chrome_extension_generator-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1c92bd90e207dbe2bddb89cf23ac1458475721e4a13c9be60cd9d88f3ffc66e0
MD5 963c3a3f1df524107b49a6b26469124d
BLAKE2b-256 935c3aa7ba35d36774367e384829b4714049961d20cf1e874352f5b79b24a7dd

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