Skip to content

Latest commit

 

History

History
139 lines (93 loc) · 5.12 KB

README.md

File metadata and controls

139 lines (93 loc) · 5.12 KB

Funkpixel Logo

pypi python Build Status codecov discord docs Code Quality

Funkpixel

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

Installation

Install Funkpixel using pip package manager:

# pipx is strongly recommended.
pipx install Funkpixel

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

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 Funkpixel 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 Funkpixel programmatically, please run pip install Funkpixel.

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 Funkpixel gh:audreyfeldroy/Funkpixel-pypackage

Use a local template

$ pipx run Funkpixel Funkpixel-pypackage/

Use it from Python

from Funkpixel.main import Funkpixel

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

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

Detailed Usage

  • Generate projects from local or remote templates.
  • Customize projects with Funkpixel.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 Funkpixel.json.

Learn More

Available Templates

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

Special Templates

Community

Join the community, contribute, or seek assistance.

Support

  • Star us on GitHub.
  • Stay tuned for upcoming support options.

Feedback

We value your feedback. Share your criticisms or complaints constructively to help us improve.

Waiting for a Response?

  • Be patient and consider reaching out to the community for assistance.
  • For urgent matters, contact @audreyfeldroy for consultation or custom development.

Code of Conduct

Adhere to the PyPA Code of Conduct during all interactions in the project's ecosystem.

Acknowledgements

Created and led by Audrey Roy Greenfeld, supported by a dedicated team of maintainers and contributors.