https://github.com/tameronline/reposmith
https://github.com/tameronline/reposmith
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tameronline/reposmith
- Owner: TamerOnLine
- License: other
- Created: 2025-09-03T07:53:08.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-09-03T08:24:07.000Z (10 months ago)
- Last Synced: 2025-09-03T10:12:26.025Z (10 months ago)
- Language: Python
- Size: 9.77 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license_utils.py
Awesome Lists containing this project
README
# โก RepoSmith
[](https://pypi.org/project/reposmith-tol/)
[](https://github.com/liebemama/RepoSmith/actions/workflows/ci.yml)
[](https://github.com/sponsors/liebemama)
**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)
```powershell
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)
```powershell
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:
```powershell
reposmith init --entry main.py
```
With extras:
```powershell
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
```powershell
py -m pip install --upgrade reposmith-tol
```
If PATH not configured, use:
```powershell
py -m reposmith.main init --entry run.py
```
---
## ๐งช Development
Run tests:
```powershell
python -m unittest discover -s tests -v
```
---
## ๐บ๏ธ Roadmap
๐ [Follow the project progress on GitHub Projects](https://github.com/orgs/liebemama/projects/2)
---
## ๐ก License
This project is licensed under the [MIT License](https://github.com/liebemama/RepoSmith/blob/main/LICENSE).
ยฉ 2025 TamerOnLine
---
## ๐ฌ Support
- ๐ **Report Issues:** [GitHub Issues](https://github.com/liebemama/RepoSmith/issues)
- ๐ก **Feature Requests:** [GitHub Issues](https://github.com/liebemama/RepoSmith/issues) (ุงุฎุชุฑ ููุน *Feature Request*)
- ๐ **Sponsor:** [GitHub Sponsors](https://github.com/sponsors/liebemama)
- ๐ง **Contact:** (info@tameronline.com)