snipkit 1.0.0

A command-line utility that creates projects from project templates, e.g. creating a Python package project from a Python package project template.

Snipkit

Create projects swiftly from snipkits (project templates) with this command-line utility. Ideal for generating Python package projects and more.

• Documentation
• GitHub
• PyPI
• License (BSD)

Installation

Install snipkit using pip package manager:

# pipx is strongly recommended.
pipx install snipkit

# If pipx is not an option,
# you can install snipkit in your Python user directory.
python -m pip install --user snipkit

Features

• Cross-Platform: Supports Windows, Mac, and Linux.
• User-Friendly: No Python knowledge required.
• Versatile: Compatible with Python 3.7 to 3.12.
• Multi-Language Support: Use templates in any language or markup format.

For Users

Quick Start

The recommended way to use Snipkit as a command line utility is to run it with pipx, which can be installed with pip install pipx, but if you plan to use Snipkit programmatically, please run pip install snipkit.

Use a GitHub template

# You'll be prompted to enter values.
# Then it'll create your Python package in the current working directory,
# based on those values.
# For the sake of brevity, repos on GitHub can just use the 'gh' prefix
$ pipx run snipkit gh:khulnasoft/snipkit

Use a local template

$ pipx run snipkit snipkit-pypackage/

Use it from Python

from snipkit.main import snipkit

# Create project from the snipkit-pypackage/ template
snipkit('snipkit-pypackage/')

# Create project from the snipkit-pypackage.git repo template
snipkit('gh:audreyfeldroy//snipkit-pypackage.git')

Detailed Usage

• Generate projects from local or remote templates.
• Customize projects with snipkit.json prompts.
• Utilize pre-prompt, pre- and post-generate hooks.

Learn More

For Template Creators

• Utilize unlimited directory nesting.
• Employ Jinja2 for all templating needs.
• Define template variables easily with snipkit.json.

Learn More

Available Templates

Discover a variety of ready-to-use templates on GitHub.