Skip to main content

Kickstart your projects: git init + Makefile generation

Project description

initial-commit

Kickstart your projects: interactive git setup + Makefile generation.

initial-commit is a lightweight CLI tool that removes friction when starting a new project. Initialize your repo, generate a clean Makefile, and start coding in seconds.


🚀 Installation

pip install initial-commit

For development:

git clone https://github.com/dallatIkes/initial-commit.git
cd initial-commit
pip install -e .

⚡ Quick Start

initial-commit

Follow the interactive prompts:

✦ initial-commit — project kickstart

? Git setup:
  ❯ Init a new repository
    Clone an existing repo
    Skip

? Generate a Makefile? (Y/n)

? Choose a template:
  ❯ python.mk
    node.mk

🧠 Non-interactive usage

Perfect for scripts and advanced users:

initial-commit --init
initial-commit --clone https://github.com/user/repo
initial-commit --template python.mk
initial-commit --init --template python.mk --force

List available templates:

initial-commit --list-templates

📦 Built-in templates

Template Stack
python.mk Python (pytest, flake8)
node.mk Node.js (npm, eslint)

🧩 Custom templates

You can extend initial-commit with your own templates.

Create a folder named initial_commit_templates/ at the root of your project:

my-project/
└── initial_commit_templates/
    └── rust.mk

Your templates will:

  • be automatically detected
  • override built-in templates with the same name

✨ Features

  • Interactive CLI (guided setup)
  • Non-interactive mode (scriptable)
  • Git init & clone support
  • Built-in and custom Makefile templates
  • Safe overwrite with --force

🛣️ Roadmap

  • Community template registry
  • Shell completion (bash, zsh, fish)
  • Project name prompt + auto-create folder
  • Template packs (advanced setups)

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.


📄 License

MIT © dallatIkes

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

initial_commit-0.1.0.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

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

initial_commit-0.1.0-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file initial_commit-0.1.0.tar.gz.

File metadata

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

File hashes

Hashes for initial_commit-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3eae010bd31bf3812c3655a76276a79e88bffa634f9959c943a68855916e4927
MD5 7f5e8b89791b831994e4971e9aaebfc6
BLAKE2b-256 9c852384e8beea09395a3e4b92850f35e2b2e38b956a0494c21d9f9d615fbfa8

See more details on using hashes here.

File details

Details for the file initial_commit-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: initial_commit-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for initial_commit-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d3ac61c3dccb72754b9c9ecd566f2c29da6273f570eb7c20bebf81858025950f
MD5 daa34190391bd75773b511c682c6577e
BLAKE2b-256 4ef3e295fdbfcea4c4d3048a2fbfb1bea3528673d16f805b5dce71f33035c97c

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