reposmith-tol 0.1.1

Portable project bootstrapper (venv, gitignore, license, vscode, etc.)

⚡ RepoSmith

RepoSmith is a portable Python library & CLI tool that helps you bootstrap new projects instantly.
With one command, you get a ready-to-code environment including virtualenv, config files, VS Code setup, .gitignore, and license.

---

✨ Features

• 🚀 Quick project setup with a single command
• 🐍 Python ≥ 3.12 support
• 📦 Automatic virtual environment creation (.venv)
• 📄 Generates essential files:
  • setup-config.json
  • requirements.txt
  • app.py
  • .vscode/ (settings + launch config)
  • .gitignore
  • LICENSE (MIT by default)
• 🤖 Preconfigured GitHub Actions workflow
• 🛡️ Built-in license templates (MIT, Apache-2.0)

---

⚡ Quick Start

The fastest way to bootstrap a new project:

cd MyProject
py -m reposmith.main

This will:

• create .venv/
• add requirements.txt, app.py, .gitignore, LICENSE, .vscode/
• configure everything automatically with defaults.

👉 Optional flags:

• --ci create → add GitHub Actions workflow
• --author "YourName" → set your name in LICENSE

---

📦 Installation

From source (local dev)

git clone https://github.com/TamerOnLine/RepoSmith.git
cd RepoSmith
pip install -e .

From GitHub (direct)

pip install "git+https://github.com/TamerOnLine/RepoSmith.git@main"

---

🚀 Usage

CLI

# Create new project structure in current folder
reposmith --ci create --gitignore python --author "Tamer"

# Or via module syntax (always works)
py -m reposmith.main --ci create --gitignore python --author "Tamer"

Options

--ci {skip|create|force}    Configure GitHub Actions workflow
--ci-python VERSION         Python version for CI (default: 3.12)
--gitignore {python|node|django}
--license {MIT|Apache-2.0}  License type (default: MIT)
--author NAME               Author name for LICENSE
--year YYYY                 Year in LICENSE header
--root PATH                 Target project root (absolute/relative)

---

Example

cd MyNewProject
reposmith --ci create --gitignore django --license Apache-2.0 --author "Tamer"

Generates:

MyNewProject/
├── .venv/
├── .vscode/
│   ├── settings.json
│   ├── launch.json
├── app.py
├── requirements.txt
├── setup-config.json
├── .gitignore
├── LICENSE
└── .github/workflows/test-main.yml

---

🧩 Library API

You can also use RepoSmith programmatically:

from reposmith.venv_utils import create_virtualenv, upgrade_pip, install_requirements

venv_dir = "./.venv"
req_file = "./requirements.txt"

create_virtualenv(venv_dir)
upgrade_pip(venv_dir)
install_requirements(venv_dir, req_file)

---

🛡️ License

This project is licensed under the MIT License.
© 2025 TamerOnLine