Metadata-Version: 2.4
Name: initial-commit
Version: 0.1.1
Summary: Kickstart your projects: git init + Makefile generation
Author-email: dallatIkes <samy.chaabi1@gmail.com>
License: MIT License
        
        Copyright (c) 2025 dallatIkes
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Keywords: cli,git,makefile,scaffold,developer-tools
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Build Tools
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: questionary>=2.0
Dynamic: license-file

# 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

```bash
pip install initial-commit
```

For development:

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

---

## ⚡ Quick Start

```bash
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:

```bash
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:

```bash
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
