Metadata-Version: 2.4
Name: mk-scaffold
Version: 2.0.0b10
Summary: A cookiecutter clone. A command-line utility that creates projects from templates.
Author-email: Julien Lecomte <julien@lecomte.at>
License-Expression: MIT
Project-URL: Homepage, https://gitlab.com/cappysan/apps/mk-scaffold
Project-URL: Documentation, https://mk-scaffold.docs.cappysan.dev/
Project-URL: Source code, https://gitlab.com/cappysan/apps/mk-scaffold
Project-URL: Bug tracker, https://gitlab.com/cappysan/apps/mk-scaffold/-/issues
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: arrow==1.4.0
Requires-Dist: boltons==25.0.0
Requires-Dist: cerberus==1.3.8
Requires-Dist: certifi==2025.11.12
Requires-Dist: charset-normalizer==3.4.4
Requires-Dist: click==8.3.0
Requires-Dist: cloup==3.0.8
Requires-Dist: filelock==3.20.0
Requires-Dist: gitdb==4.0.12
Requires-Dist: gitpython==3.1.45
Requires-Dist: idna==3.11
Requires-Dist: jinja2==3.1.6
Requires-Dist: jinja2-time==0.2.0
Requires-Dist: jinjazzle==1.2.4
Requires-Dist: markupsafe==3.0.3
Requires-Dist: prompt-toolkit==3.0.52
Requires-Dist: python-dateutil==2.9.0.post0
Requires-Dist: python-slugify==8.0.4
Requires-Dist: pyyaml==6.0.3
Requires-Dist: requests==2.32.5
Requires-Dist: six==1.17.0
Requires-Dist: smmap==5.0.2
Requires-Dist: text-unidecode==1.3
Requires-Dist: torxtools==1.2.1
Requires-Dist: tzdata==2025.2
Requires-Dist: urllib3==2.5.0
Requires-Dist: wcwidth==0.2.14
Requires-Dist: xdg==6.0.0
Provides-Extra: dev
Dynamic: license-file

[![license](https://img.shields.io/badge/license-MIT-brightgreen)](https://spdx.org/licenses/MIT.html)
[![documentation](https://img.shields.io/badge/documentation-html-informational)](https://mk-scaffold.docs.cappysan.dev)
[![pipelines](https://gitlab.com/cappysan/mk-scaffold/badges/main/pipeline.svg)](https://gitlab.com/cappysan/mk-scaffold/pipelines)
[![coverage](https://gitlab.com/cappysan/mk-scaffold/badges/main/coverage.svg)](https://mk-scaffold.docs.cappysan.dev//coverage/index.html)

# mk-scaffold -- make scaffold

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


## Table of contents
1. [Features](#features)  
2. [Installation](#installation)  
3. [Usage](#usage)  
4. [Support & Sponsorship](#support)  
5. [License](#license)  
6. [Links](#links)  


## Features <a name="features"></a>

- 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 <a name="installation"></a>

You can install the latest version from PyPI package repository.

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


## Usage <a name="usage"></a>

Sample command line usage:

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

Sample scaffold template file `scaffold.yml`:

~~~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 <a name="support"></a>

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](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](https://buymeacoffee.com/cappysan), [Patreon](https://www.patreon.com/c/cappysan), [GitHub](https://github.com/sponsors/cappysan), or [Bitcoin (bc1qw0w2k93kwk3n3ny4fyqg7v4awur2g7dyzta8kg)](https://addrs.to/pay/BTC/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 <a name="license"></a>

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.


## Links <a name="links"></a>

  * Documentation: [https://mk-scaffold.docs.cappysan.dev/](https://mk-scaffold.docs.cappysan.dev/)
  * Source code: [https://gitlab.com/cappysan/apps/mk-scaffold](https://gitlab.com/cappysan/apps/mk-scaffold)
  * PyPi: [https://pypi.org/project/mk-scaffold](https://pypi.org/project/mk-scaffold)
  * Discord: [https://discord.gg/SsY3CAdp4Q](https://discord.gg/SsY3CAdp4Q)
