Skip to main content

A command-line utility that creates projects from templates.

Project description

license documentation pipelines coverage

mk-scaffold -- make scaffold

A cookiecutter clone. A command-line utility that creates projects from templates.

Table of contents

  1. Features
  2. Installation
  3. Usage
  4. Support & Sponsorship
  5. License
  6. Links

Features

  • Conditional questions.
  • Templated answers.
  • You don't have to know/write Python code to use.
  • Project templates can be in any programming language or markup format: Python, JavaScript, Ruby, CoffeeScript, RST, Markdown, CSS, HTML, you name it. You can use multiple languages in the same project template.

Installation

You can install the latest version from PyPI package repository.

pipx install --pip-args="--pre"  mk-scaffold

Usage

Sample command line usage:

mk-scaffold clone git@gitlab.com:cappysan/scaffolds/python-template.git

Sample scaffold template file scaffold.yml:

questions:
  - name: "project_name"
    schema:
      min_length: 1

  - name: "project_short_description"
    schema:
      default: "Lorem ipsum sit dolor amet."
      max_length: 120

Support & Sponsorship

You can help support this project, and all Cappysan projects, through the following actions:

  • ⭐ Star the repository on GitLab, GitHub, or both to increase visibility and community engagement.

  • 💬 Join the Discord community: https://discord.gg/SsY3CAdp4Q to connect, contribute, share feedback, and/or stay updated.

  • 🛠️ Contribute by submitting issues, improving documentation, or creating pull requests to help the project grow.

  • ☕ Support financially through Buy Me a Coffee, GitHub, or Bitcoin (bc1qw0w2k93kwk3n3ny4fyqg7v4awur2g7dyzta8kg). Your contributions directly sustain ongoing development and maintenance, including server costs.

Your support ensures these projects continue to improve, expand, and remain freely available to everyone.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Links

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

mk_scaffold-2.0.0rc3.tar.gz (32.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mk_scaffold-2.0.0rc3-py3-none-any.whl (39.8 kB view details)

Uploaded Python 3

File details

Details for the file mk_scaffold-2.0.0rc3.tar.gz.

File metadata

  • Download URL: mk_scaffold-2.0.0rc3.tar.gz
  • Upload date:
  • Size: 32.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for mk_scaffold-2.0.0rc3.tar.gz
Algorithm Hash digest
SHA256 b885b09a36a270cb7b144f2bbf43c341208fd0707d4da1dae758691b566f38be
MD5 0a22877c16d23f0ab6de35c92d8a2a19
BLAKE2b-256 43823d8b69db4c18978f213fb981b13f06582dcb41f4c35d9f116b77c80e5efc

See more details on using hashes here.

File details

Details for the file mk_scaffold-2.0.0rc3-py3-none-any.whl.

File metadata

  • Download URL: mk_scaffold-2.0.0rc3-py3-none-any.whl
  • Upload date:
  • Size: 39.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for mk_scaffold-2.0.0rc3-py3-none-any.whl
Algorithm Hash digest
SHA256 7038cc7229a94d2ab2132c34346a2ffb4e47020fa0e8e79a11f94289c22e693d
MD5 f7b2330ebd0953535bd3b5e491416721
BLAKE2b-256 69eeab36a9374b48c1ca82ef69ccf35a9506b014c0aaac6420100c55fc33888f

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