Skip to main content

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

Project description

Python Pypi Docs LOC Downloads Downloads License Forks Issues Project Status

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


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: erdogant@gmail.com
  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.

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

biscuitcutter-1.1.0.tar.gz (536.3 kB view details)

Uploaded Source

Built Distribution

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

biscuitcutter-1.1.0-py3-none-any.whl (534.2 kB view details)

Uploaded Python 3

File details

Details for the file biscuitcutter-1.1.0.tar.gz.

File metadata

  • Download URL: biscuitcutter-1.1.0.tar.gz
  • Upload date:
  • Size: 536.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for biscuitcutter-1.1.0.tar.gz
Algorithm Hash digest
SHA256 29e7a1b132399c7a9628a31c5a834f11527b71083d979e38f9ef479be1b5a3b2
MD5 34c8cf7112dcdaeb26752d61975dad53
BLAKE2b-256 ddcea26c4361d3ececa4292c269755d0476ab3a5993cb9e02dd37a9e56eaacf6

See more details on using hashes here.

File details

Details for the file biscuitcutter-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: biscuitcutter-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 534.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for biscuitcutter-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a3fa63ca355959a0079584dedaeea849418c56d3e4d5e188d09dcd4152ca7171
MD5 9dacb6947e8c556136359aaeb7aa7b4a
BLAKE2b-256 9b6028bcde23722b48f34883dfc3297f55ae731603da301c541f62d4f084bc47

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