Personalized project scaffolding CLI
Project description
ProjectME
A CLI for scaffolding Python and React projects.
ProjectME generates clean, ready-to-use project structures from the command line. Pick your stack, pass a few flags, and start coding.
Installation
pip install projectme
Or install it from source in editable mode:
git clone https://github.com/tutu-firmino/ProjectME.git
cd ProjectME
pip install -e .
Usage
NOTE: Both commands
projectme create...andproject create...work.
Create a React project
projectme create my-app react
With Tailwind CSS:
projectme create my-app react --tailwind
Using Create React App instead of Vite:
projectme create my-app react --cra
Create a Python project
projectme create my-service python
With a web framework:
projectme create my-api python --fastapi
projectme create my-site python --flask
projectme create my-project python --django
Skip Git initialization or virtual environment creation:
projectme create my-service python --no-git --no-venv
Global options
| Option | Description |
|---|---|
--tailwind |
Add Tailwind CSS (React only) |
--cra |
Use Create React App instead of Vite (React only) |
--flask |
Scaffold a Flask project (Python only) |
--django |
Scaffold a Django project (Python only) |
--fastapi |
Scaffold a FastAPI project (Python only) |
--no-git |
Skip git init |
--no-venv |
Skip virtual environment creation (Python only) |
Development
Install development dependencies:
pip install -e .[test,lint,build]
Run the test suite:
pytest
Run the linter:
ruff check .
ruff format --check .
Build and upload:
python -m build
twine upload dist/*
Roadmap
We are currently on version v0.3.0.
Upcoming features
- (guaranteed) v0.4.0: in addition to more available stacks, a new manifest file feature will come.
- (planned) v0.5.0: AI-powered smart committing tool
- (guaranteed) v1.0.0: complete coverage and project stabilization
License
Feedback
We welcome feedback and suggestions to help improve the project. Thank you!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file projectme-0.3.0.tar.gz.
File metadata
- Download URL: projectme-0.3.0.tar.gz
- Upload date:
- Size: 10.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fa7927d2b4df89776e672ee3d3b93ccc66a8456f425a854e345d525d73809473
|
|
| MD5 |
33c905681b1d0968bb0c0cbb11a38d47
|
|
| BLAKE2b-256 |
eeaa5b7b02afa3cd62ace8b0fca80bf27b9874bca458eae973c2531b54fc10de
|
File details
Details for the file projectme-0.3.0-py3-none-any.whl.
File metadata
- Download URL: projectme-0.3.0-py3-none-any.whl
- Upload date:
- Size: 8.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2f7783bbb42871f6d3a1130a07291cb477052527103f15a2c2f2ec58a2069a2b
|
|
| MD5 |
fec95704c3bb361cb31ec3d0884ed50a
|
|
| BLAKE2b-256 |
79563a4e029dce3fbd5c0003fca8d2c4fe9f8737e4789482ead05f1253d0b8a5
|