Skip to main content

Bootstrap utility to create new Python projects with standardized structure, templates, and configuration.

Project description

jps-cookiecutter-utils

Build Publish to PyPI codecov

🚀 Overview

jps-cookiecutter-utils is a Python-based bootstrapping utility designed to create new code repositories with a standardized structure, metadata, and configuration files.
It automates directory creation, file copying, placeholder substitution, and logging, ensuring uniformity across all your projects.


✨ Features

  • 🚀 Bootstrap new projects from a unified templates/ directory
  • 📁 Create consistent directory layouts automatically
  • 🧩 Replace placeholders in files using CLI or input file values
  • 🧠 Interactive prompts for missing fields
  • 🪵 Comprehensive logging with separated INFO/WARNING levels
  • 🎨 Emoji-based verbose progress display
  • ⚙️ Typer-powered CLI for intuitive commands

🧰 Example Usage

python src/scripts/bootstrap.py \
  --outdir . \
  --code-repository jps-azure-utils \
  --author "Jaideep Sundaram" \
  --author-email jai.python3@gmail.com \
  --code-repo-org jai-python3 \
  --code-repo-summary "Utilities for interacting with Microsoft Azure services." \
  --infile bootstrap.txt \
  --verbose

This command creates a new project under ./jps-azure-utils/ with all template files properly substituted.


📦 Installation

make install

🧪 Development

make install-build-tools
make fix && make format && make lint
make test

For detailed developer documentation, see README_DEV.md.


📜 License

MIT License © Jaideep Sundaram

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

jps_cookiecutter_utils-0.4.0.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

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

jps_cookiecutter_utils-0.4.0-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

Details for the file jps_cookiecutter_utils-0.4.0.tar.gz.

File metadata

  • Download URL: jps_cookiecutter_utils-0.4.0.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for jps_cookiecutter_utils-0.4.0.tar.gz
Algorithm Hash digest
SHA256 c72c4f2c05bf89d133d38d6d4f791c8f78bb8fa730ffa57012f77cd130b62a0f
MD5 1a0727a976f0be08dbd8a450789c1a9d
BLAKE2b-256 de624d3ff2b6a52ef212f745f50bb943d1d7722da3c14a22de601c851665240a

See more details on using hashes here.

File details

Details for the file jps_cookiecutter_utils-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jps_cookiecutter_utils-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b2c4191154aa0a688601601893d82352a2ecb12fd7553c8a65fb3ee2f39e59ce
MD5 b0ada76366b749841ff26da1996163a9
BLAKE2b-256 14e2625f16ac9b8689ab9e3e7aabfea015b2d4f3dd920f83ffcab4cf9a6d3a3e

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