Skip to content

TamerOnLine/RepoSmith

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

⚡ RepoSmith

PyPI version Python License CI Sponsor

RepoSmith is a portable Python project bootstrapper — a zero-dependency CLI & library that helps you spin up new projects instantly.
With one command, you get a ready-to-code environment: virtualenv, config files, VS Code setup, .gitignore, LICENSE, and optional CI.


✨ Features

  • 🚀 Zero dependencies — built only with Python stdlib
  • ⚙️ Virtual environment auto-created (.venv)
  • 📦 requirements.txt scaffolded (empty but ready)
  • 📝 Entry file (main.py or run.py) with a welcome message
  • 🛡 LICENSE (MIT by default, more soon)
  • 🙈 .gitignore presets (Python, Node, Django…)
  • 💻 VS Code config (settings.json, launch.json, workspace)
  • 🔄 GitHub Actions workflow (.github/workflows/ci.yml)
  • 🔧 Idempotent: runs safely again without overwriting unless --force

⚡ Quick Start

Option 1 — run via Python module (always works)

cd MyProject
py -m reposmith.main init --entry run.py --with-vscode --with-ci

Option 2 — run via CLI (if Scripts folder is on PATH)

reposmith init --entry run.py --with-vscode --with-ci

Both commands will:

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

🚀 Usage

Basic:

reposmith init --entry main.py

With extras:

reposmith init --entry run.py --with-ci --with-gitignore --with-license --with-vscode --author "YourName"

Flags:

  • --force → overwrite existing files (with .bak backup)
  • --no-venv → skip creating .venv
  • --with-license → add LICENSE (MIT)
  • --with-gitignore → add .gitignore (Python preset by default)
  • --with-vscode → add VS Code config
  • --with-ci → add GitHub Actions workflow
  • --author / --year → customize LICENSE metadata
  • --ci-python → set Python version for CI (default: 3.12)

📦 Installation

py -m pip install --upgrade reposmith-tol

If PATH not configured, use:

py -m reposmith.main init --entry run.py

🧪 Development

Run tests:

python -m unittest discover -s tests -v

🗺️ Roadmap

🔗 Follow the project progress on GitHub Projects


🛡 License

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


💬 Support

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published

Languages