biscuitcutter 1.0.0

biscuitcutter – scaffold a new Python repo from a template in seconds.

biscuitcutter is a new repository scaffolder for Python projects.

Create a new Python package or repository with a single command! ⭐️Star it if you like it⭐️

---

Key Features

Feature	Description
Interactive CLI	Scaffold a new Python repository with prompts for repo name, author info, and more.
Template-Based	Uses a pre-configured template to create a ready-to-use project structure.
Placeholder Replacement	Automatically replaces placeholders (repo name, author, email, GitHub username) in all files.

---

Resources and Links

• Documentation: Website
• Bug Reports and Feature Requests: GitHub Issues

---

Installation

Install biscuitcutter from PyPI

pip install biscuitcutter

---

Usage

After installation, run the interactive CLI:

biscuitcutter

This will prompt you for:

• Repository / package name (required)
• Author full name (required)
• Author e-mail (optional)
• GitHub username (optional, defaults to lowercase author name without spaces)
• Parent directory (optional, defaults to current directory)

Alternatively, you can import and call the main function directly:

from biscuitcutter import main
main()

---

Example Session

🍪  biscuitcutter – new repo scaffolder

───────────────────────────────────────────
  Repository / package name: my_project
  Author full name: Erdogan Taskesen
  Author e-mail: [e-mail]
  GitHub username: erdogant
  Parent directory (leave blank for current dir):

✔  Created directory: /path/to/my_project
✔  Template extracted to: /path/to/my_project
✔  Placeholders replaced.

🎉  Done!  Your new repo is ready at:
    /path/to/my_project

---

Contributors

Setting up and maintaining biscuitcutter has been possible thanks to users and contributors. Thanks to:

Maintainer

• Erdogan Taskesen, github: erdogant
• Contributions are welcome.