projectstarter-cli 0.1.0__py3-none-any.whl

projectstarter/cli.py

@@ -0,0 +1,173 @@
+import argparse
+
+from .registry import GENERATORS, PROJECT_INFO
+from .utils import validate_project_name
+from .doctor import run_doctor
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="ProjectStarter - Create projects quickly"
+    )
+
+    parser.add_argument(
+        "--version",
+        action="version",
+        version="ProjectStarter 0.1.0"
+    )
+
+    subparsers = parser.add_subparsers(
+        dest="command"
+    )
+
+    # create command
+    create_parser = subparsers.add_parser(
+        "create",
+        help="Create a new project"
+    )
+
+    create_parser.add_argument(
+        "project_type",
+        nargs="?",
+        choices=GENERATORS.keys(),
+        help="Type of project to create"
+    )
+
+    create_parser.add_argument(
+        "project_name",
+        nargs="?",
+        help="Name of the project"
+    )
+
+    # list command
+    subparsers.add_parser(
+        "list",
+        help="List available project types"
+    )
+
+    # info command
+    info_parser = subparsers.add_parser(
+        "info",
+        help="Show information about a project type"
+    )
+
+    # doctor command
+    subparsers.add_parser(
+        "doctor",
+        help="Check ProjectStarter installation"
+    )
+
+    info_parser.add_argument(
+        "project_type",
+        choices=PROJECT_INFO.keys(),
+        help="Project type to show information about"
+    )
+
+    args = parser.parse_args()
+
+    # create project
+    if args.command == "create":
+
+        try:
+
+            if args.project_type is None:
+
+                print("\nChoose a project type:\n")
+
+                project_types = list(GENERATORS.keys())
+
+                for index, project_type in enumerate(
+                    project_types,
+                    start=1
+                ):
+                    print(f"{index}. {project_type}")
+
+                print()
+
+                choice = input("Enter your choice: ")
+
+                try:
+                    choice = int(choice)
+                    project_type = project_types[choice - 1]
+
+                except (ValueError, IndexError):
+                    print("Invalid choice.")
+                    return
+
+                project_name = input(
+                    "Enter project name: "
+                )
+
+                if not validate_project_name(project_name):
+                    print(
+                        "Invalid project name."
+                        "\nUse only letters, numbers, and underscores."
+                        "\nProject name must not start with a number."
+                    )
+                    return
+
+                generator = GENERATORS[project_type]
+
+                generator(project_name)
+
+            else:
+
+                generator = GENERATORS[args.project_type]
+
+                if args.project_name is None:
+                    args.project_name = input(
+                        "Enter project name: "
+                    )
+
+                if not validate_project_name(args.project_name):
+                    print(
+                        "Invalid project name."
+                        "\nUse only letters, numbers, and underscores."
+                        "\nProject name must not start with a number."
+                    )
+                    return
+
+                generator(args.project_name)
+
+        except FileExistsError as error:
+
+            print(f"\nError: {error}")
+
+    # list projects
+    elif args.command == "list":
+
+        print("\nAvailable project types:\n")
+
+        for project_type in GENERATORS:
+            print(f"  {project_type}")
+
+        print()
+
+    # info project
+    elif args.command == "info":
+
+        info = PROJECT_INFO[args.project_type]
+
+        print(f"\n{args.project_type.capitalize()}")
+        print("─" * 30)
+
+        print(f"Description: {info['description']}")
+        print(
+            f"Virtual environment: "
+            f"{info['virtual_environment']}"
+        )
+        print(
+            f"Automatic installation: "
+            f"{info['automatic_installation']}"
+        )
+
+        print("\nRun:")
+        print(f"    {info['run']}")
+
+        print()
+
+    elif args.command == "doctor":
+        run_doctor()
+
+
+if __name__ == "__main__":
+    main()

projectstarter/doctor.py

@@ -0,0 +1,31 @@
+import sys
+
+from .registry import GENERATORS, PROJECT_INFO
+
+
+def run_doctor():
+    print("\nProjectStarter Doctor")
+    print("─" * 30)
+
+    # Python
+    print("✓ Python")
+    print(f"  Version: {sys.version.split()[0]}")
+
+    # Registry
+    print("✓ Registry")
+
+    # Generators
+    print(f"✓ Generators ({len(GENERATORS)})")
+
+    for project_type in GENERATORS:
+        print(f"  - {project_type}")
+
+    # Project information
+    print("✓ Project Info")
+
+    if set(GENERATORS.keys()) == set(PROJECT_INFO.keys()):
+        print("  All project information is available.")
+    else:
+        print("  Warning: Project information is incomplete.")
+
+    print("\nEverything looks good! ✓")

projectstarter/generator.py

@@ -0,0 +1,427 @@
+from pathlib import Path
+import subprocess
+import sys
+
+
+def run_command(command, cwd=None):
+    """Run a command."""
+    subprocess.run(
+        command,
+        cwd=cwd,
+        check=True
+    )
+
+
+def create_virtual_environment(project_path):
+    """Create a virtual environment."""
+
+    venv_path = project_path / ".venv"
+
+    print("Creating virtual environment...")
+
+    run_command(
+        [sys.executable, "-m", "venv", ".venv"],
+        cwd=project_path
+    )
+
+    if sys.platform == "win32":
+        return venv_path / "Scripts" / "python.exe"
+
+    return venv_path / "bin" / "python"
+
+
+def upgrade_pip(python_exe):
+    """Upgrade pip."""
+
+    print("Upgrading pip...")
+
+    run_command(
+        [
+            str(python_exe),
+            "-m",
+            "pip",
+            "install",
+            "--upgrade",
+            "pip"
+        ]
+    )
+
+
+def install_package(python_exe, package):
+    """Install a package."""
+
+    print(f"Installing {package}...")
+
+    run_command(
+        [
+            str(python_exe),
+            "-m",
+            "pip",
+            "install",
+            package
+        ]
+    )
+
+
+def save_requirements(python_exe, project_path):
+    """Create requirements.txt."""
+
+    result = subprocess.run(
+        [
+            str(python_exe),
+            "-m",
+            "pip",
+            "freeze"
+        ],
+        capture_output=True,
+        text=True,
+        check=True
+    )
+
+    (project_path / "requirements.txt").write_text(
+        result.stdout,
+        encoding="utf-8"
+    )
+
+
+def create_gitignore(project_path, django=False):
+    """Create .gitignore."""
+
+    content = """__pycache__/
+*.py[cod]
+
+.venv/
+venv/
+
+.env
+
+.pytest_cache/
+.vscode/
+"""
+
+    if django:
+        content += "\ndb.sqlite3\n"
+
+    (project_path / ".gitignore").write_text(
+        content,
+        encoding="utf-8"
+    )
+
+
+def create_python_project(project_name):
+    """Create a basic Python project."""
+
+    project_path = Path(project_name)
+
+    if project_path.exists():
+        raise FileExistsError(
+            f"Project '{project_name}' already exists."
+        )
+
+    print(f"Creating Python project '{project_name}'...")
+
+    package_path = project_path / "src" / project_name
+    tests_path = project_path / "tests"
+
+    package_path.mkdir(parents=True)
+    tests_path.mkdir(parents=True)
+
+    (package_path / "__init__.py").write_text(
+        "",
+        encoding="utf-8"
+    )
+
+    (package_path / "main.py").write_text(
+        """def main():
+    print("Hello from your new Python project!")
+
+
+if __name__ == "__main__":
+    main()
+""",
+        encoding="utf-8"
+    )
+
+    (tests_path / "test_main.py").write_text(
+        """def test_example():
+    assert True
+""",
+        encoding="utf-8"
+    )
+
+    create_gitignore(project_path)
+
+    (project_path / "requirements.txt").write_text(
+        "",
+        encoding="utf-8"
+    )
+
+    readme = (
+        f"# {project_name}\n\n"
+        "A Python project created with ProjectStarter.\n\n"
+        "## Run\n\n"
+        "Activate the virtual environment on Windows:\n\n"
+        ".venv\\Scripts\\activate\n\n"
+        "Run the application:\n\n"
+        "python src/"
+        f"{project_name}/main.py\n"
+    )
+
+    (project_path / "README.md").write_text(
+        readme,
+        encoding="utf-8"
+    )
+
+    print(
+        f"Project '{project_name}' created successfully!"
+    )
+
+
+def create_django_project(project_name):
+    """Create a Django project."""
+
+    project_path = Path(project_name)
+
+    if project_path.exists():
+        raise FileExistsError(
+            f"Project '{project_name}' already exists."
+        )
+
+    print(f"Creating Django project '{project_name}'...")
+
+    project_path.mkdir(parents=True)
+
+    python_exe = create_virtual_environment(
+        project_path
+    )
+
+    upgrade_pip(python_exe)
+
+    install_package(
+        python_exe,
+        "django"
+    )
+
+    print("Creating Django project files...")
+
+    run_command(
+        [
+            str(python_exe),
+            "-m",
+            "django",
+            "startproject",
+            "config",
+            "."
+        ],
+        cwd=project_path
+    )
+
+    save_requirements(
+        python_exe,
+        project_path
+    )
+
+    create_gitignore(
+        project_path,
+        django=True
+    )
+
+    readme = (
+        f"# {project_name}\n\n"
+        "A Django project created with ProjectStarter.\n\n"
+        "## Activate virtual environment\n\n"
+        "Windows:\n\n"
+        ".venv\\Scripts\\activate\n\n"
+        "## Run the project\n\n"
+        "python manage.py runserver\n\n"
+        "## Project URL\n\n"
+        "http://127.0.0.1:8000/\n"
+    )
+
+    (project_path / "README.md").write_text(
+        readme,
+        encoding="utf-8"
+    )
+
+    print(
+        f"Django project '{project_name}' "
+        "created successfully!"
+    )
+
+
+def create_flask_project(project_name):
+    """Create a Flask project."""
+
+    project_path = Path(project_name)
+
+    if project_path.exists():
+        raise FileExistsError(
+            f"Project '{project_name}' already exists."
+        )
+
+    print(f"Creating Flask project '{project_name}'...")
+
+    project_path.mkdir(parents=True)
+
+    python_exe = create_virtual_environment(
+        project_path
+    )
+
+    upgrade_pip(python_exe)
+
+    install_package(
+        python_exe,
+        "flask"
+    )
+
+    app_path = project_path / "app"
+    templates_path = app_path / "templates"
+    static_path = app_path / "static"
+
+    templates_path.mkdir(parents=True)
+    static_path.mkdir(parents=True)
+
+    (app_path / "__init__.py").write_text(
+        """from flask import Flask
+
+
+def create_app():
+    app = Flask(__name__)
+
+    @app.route("/")
+    def home():
+        return "Hello from Flask!"
+
+    return app
+""",
+        encoding="utf-8"
+    )
+
+    (project_path / "run.py").write_text(
+        """from app import create_app
+
+
+app = create_app()
+
+
+if __name__ == "__main__":
+    app.run(debug=True)
+""",
+        encoding="utf-8"
+    )
+
+    save_requirements(
+        python_exe,
+        project_path
+    )
+
+    create_gitignore(
+        project_path
+    )
+
+    readme = (
+        f"# {project_name}\n\n"
+        "A Flask project created with ProjectStarter.\n\n"
+        "## Activate virtual environment\n\n"
+        "Windows:\n\n"
+        ".venv\\Scripts\\activate\n\n"
+        "## Run the project\n\n"
+        "python run.py\n\n"
+        "## Project URL\n\n"
+        "http://127.0.0.1:5000/\n"
+    )
+
+    (project_path / "README.md").write_text(
+        readme,
+        encoding="utf-8"
+    )
+
+    print(
+        f"Flask project '{project_name}' "
+        "created successfully!"
+    )
+
+def create_fastapi_project(project_name):
+    """Create a FastAPI project."""
+
+    project_path = Path(project_name)
+
+    if project_path.exists():
+        raise FileExistsError(
+            f"Project '{project_name}' already exists."
+        )
+
+    print(f"Creating FastAPI project '{project_name}'...")
+
+    project_path.mkdir(parents=True)
+
+    python_exe = create_virtual_environment(
+        project_path
+    )
+
+    upgrade_pip(python_exe)
+
+    install_package(
+        python_exe,
+        "fastapi"
+    )
+
+    install_package(
+        python_exe,
+        "uvicorn"
+    )
+
+    app_path = project_path / "app"
+    app_path.mkdir(parents=True)
+
+    (app_path / "__init__.py").write_text(
+        "",
+        encoding="utf-8"
+    )
+
+    (app_path / "main.py").write_text(
+        """from fastapi import FastAPI
+
+
+app = FastAPI()
+
+
+@app.get("/")
+def home():
+    return {"message": "Hello from FastAPI!"}
+""",
+        encoding="utf-8"
+    )
+
+    save_requirements(
+        python_exe,
+        project_path
+    )
+
+    create_gitignore(
+        project_path
+    )
+
+    readme = (
+        f"# {project_name}\n\n"
+        "A FastAPI project created with ProjectStarter.\n\n"
+        "## Activate virtual environment\n\n"
+        "Windows:\n\n"
+        ".venv\\Scripts\\activate\n\n"
+        "## Run\n\n"
+        "uvicorn app.main:app --reload\n\n"
+        "## API\n\n"
+        "http://127.0.0.1:8000/\n\n"
+        "## Swagger Docs\n\n"
+        "http://127.0.0.1:8000/docs\n"
+    )
+
+    (project_path / "README.md").write_text(
+        readme,
+        encoding="utf-8"
+    )
+
+    print(
+        f"FastAPI project '{project_name}' "
+        "created successfully!"
+    )

projectstarter/registry.py

@@ -0,0 +1,43 @@
+from .generator import (
+    create_python_project,
+    create_django_project,
+    create_flask_project,
+    create_fastapi_project,
+)
+
+GENERATORS = {
+"python": create_python_project,
+"django": create_django_project,
+"flask": create_flask_project,
+"fastapi": create_fastapi_project,
+}
+
+PROJECT_INFO = {
+    "python": {
+        "description": "A basic Python project",
+        "virtual_environment": "Yes",
+        "automatic_installation": "No",
+        "run": "python src/<project_name>/main.py",
+    },
+
+    "django": {
+        "description": "Python web framework",
+        "virtual_environment": "Yes",
+        "automatic_installation": "Yes",
+        "run": "python manage.py runserver",
+    },
+
+    "flask": {
+        "description": "Lightweight Python web framework",
+        "virtual_environment": "Yes",
+        "automatic_installation": "Yes",
+        "run": "python run.py",
+    },
+
+    "fastapi": {
+        "description": "Modern Python API framework",
+        "virtual_environment": "Yes",
+        "automatic_installation": "Yes",
+        "run": "uvicorn app.main:app --reload",
+    },
+}

projectstarter/utils.py

@@ -0,0 +1,12 @@
+import re
+
+
+def validate_project_name(project_name):
+    """Validate a project name."""
+
+    if not project_name:
+        return False
+
+    pattern = r"^[A-Za-z_][A-Za-z0-9_]*$"
+
+    return bool(re.match(pattern, project_name))

projectstarter_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,662 @@
+Metadata-Version: 2.4
+Name: projectstarter-cli
+Version: 0.1.0
+Summary: A Python CLI tool for quickly generating Python, Django, Flask, and FastAPI projects
+Author-email: Mohamed Ali Ismail Jami <mohamedali32947@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/hamada-cool/projectstarter
+Project-URL: Repository, https://github.com/hamada-cool/projectstarter
+Project-URL: Issues, https://github.com/hamada-cool/projectstarter/issues
+Keywords: cli,project-generator,project-starter,python,django,flask,fastapi
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# ProjectStarter 🚀
+
+ProjectStarter is a Python CLI tool created by **Mohamed Ali** for quickly creating ready-to-use project structures.
+
+It helps developers avoid manually creating folders, files, virtual environments, installing framework dependencies, and preparing basic project documentation.
+
+## ✨ Features
+
+- 🐍 Create basic Python projects
+- 🌐 Create Django projects
+- ⚡ Create Flask projects
+- 🚀 Create FastAPI projects
+- 📦 Automatically create `.venv` for Django, Flask, and FastAPI projects
+- ⬆️ Automatically upgrade `pip`
+- 🔧 Automatically install required framework packages
+- 📄 Automatically generate `requirements.txt`
+- 🚫 Automatically generate `.gitignore`
+- 📝 Automatically generate a README for generated projects
+- 📋 List supported project types
+- ℹ️ Show information about each project type
+- 🩺 Check the ProjectStarter installation with `doctor`
+- 🧪 Includes automated tests
+
+---
+
+## 📋 Supported Project Types
+
+| Project Type | Virtual Environment | Automatic Dependency Installation | Run Command |
+|---|---|---|---|
+| Python | No | No | `python src/<project_name>/main.py` |
+| Django | Yes | Yes | `python manage.py runserver` |
+| Flask | Yes | Yes | `python run.py` |
+| FastAPI | Yes | Yes | `uvicorn app.main:app --reload` |
+
+> The basic Python generator creates the project structure directly. Django, Flask, and FastAPI projects receive their own `.venv` and framework dependencies automatically.
+
+---
+
+# 📦 Installation
+
+Install ProjectStarter from PyPI:
+
+```bash
+pip install projectstarter
+```
+
+Check that it is installed:
+
+```bash
+projectstarter --version
+```
+
+Show the available commands:
+
+```bash
+projectstarter --help
+```
+
+---
+
+# 🚀 Usage
+
+## 1. Create a project interactively
+
+Run:
+
+```bash
+projectstarter create
+```
+
+ProjectStarter will show the available project types:
+
+```text
+Choose a project type:
+
+1. python
+2. django
+3. flask
+4. fastapi
+```
+
+Then enter the number of the project type and the project name.
+
+Example:
+
+```text
+Enter your choice: 2
+Enter project name: myproject
+```
+
+ProjectStarter will create the project automatically.
+
+---
+
+## 2. Create a Python project
+
+Run:
+
+```bash
+projectstarter create python myproject
+```
+
+The generated structure is:
+
+```text
+myproject/
+├── src/
+│   └── myproject/
+│       ├── __init__.py
+│       └── main.py
+├── tests/
+│   └── test_main.py
+├── .gitignore
+├── requirements.txt
+└── README.md
+```
+
+### Run the Python project
+
+Windows:
+
+```powershell
+python src/myproject/main.py
+```
+
+The generated application contains a simple `main()` function.
+
+---
+
+# 🌐 Django
+
+Create a Django project:
+
+```bash
+projectstarter create django myproject
+```
+
+ProjectStarter automatically:
+
+1. Creates the project directory.
+2. Creates `.venv`.
+3. Upgrades `pip`.
+4. Installs Django.
+5. Creates the Django project using the `config` package.
+6. Creates `requirements.txt`.
+7. Creates `.gitignore`.
+8. Creates a project README.
+
+The main structure is:
+
+```text
+myproject/
+├── .venv/
+├── config/
+│   ├── __init__.py
+│   ├── asgi.py
+│   ├── settings.py
+│   ├── urls.py
+│   └── wsgi.py
+├── manage.py
+├── requirements.txt
+├── .gitignore
+└── README.md
+```
+
+### Activate the virtual environment
+
+Windows:
+
+```powershell
+cd myproject
+.venv\Scripts\activate
+```
+
+macOS/Linux:
+
+```bash
+cd myproject
+source .venv/bin/activate
+```
+
+### Run Django
+
+```bash
+python manage.py runserver
+```
+
+Open:
+
+```text
+http://127.0.0.1:8000/
+```
+
+---
+
+# ⚡ Flask
+
+Create a Flask project:
+
+```bash
+projectstarter create flask myproject
+```
+
+ProjectStarter automatically:
+
+1. Creates the project directory.
+2. Creates `.venv`.
+3. Upgrades `pip`.
+4. Installs Flask.
+5. Creates the `app` package.
+6. Creates `templates` and `static` directories.
+7. Creates `run.py`.
+8. Creates `requirements.txt`.
+9. Creates `.gitignore`.
+10. Creates a project README.
+
+The generated structure is:
+
+```text
+myproject/
+├── .venv/
+├── app/
+│   ├── __init__.py
+│   ├── templates/
+│   └── static/
+├── run.py
+├── requirements.txt
+├── .gitignore
+└── README.md
+```
+
+### Activate the virtual environment
+
+Windows:
+
+```powershell
+cd myproject
+.venv\Scripts\activate
+```
+
+macOS/Linux:
+
+```bash
+cd myproject
+source .venv/bin/activate
+```
+
+### Run Flask
+
+```bash
+python run.py
+```
+
+Open:
+
+```text
+http://127.0.0.1:5000/
+```
+
+---
+
+# 🚀 FastAPI
+
+Create a FastAPI project:
+
+```bash
+projectstarter create fastapi myproject
+```
+
+ProjectStarter automatically:
+
+1. Creates the project directory.
+2. Creates `.venv`.
+3. Upgrades `pip`.
+4. Installs FastAPI.
+5. Installs Uvicorn.
+6. Creates the `app` package.
+7. Creates `app/main.py`.
+8. Creates `requirements.txt`.
+9. Creates `.gitignore`.
+10. Creates a project README.
+
+The generated structure is:
+
+```text
+myproject/
+├── .venv/
+├── app/
+│   ├── __init__.py
+│   └── main.py
+├── requirements.txt
+├── .gitignore
+└── README.md
+```
+
+### Activate the virtual environment
+
+Windows:
+
+```powershell
+cd myproject
+.venv\Scripts\activate
+```
+
+macOS/Linux:
+
+```bash
+cd myproject
+source .venv/bin/activate
+```
+
+### Run FastAPI
+
+```bash
+uvicorn app.main:app --reload
+```
+
+API:
+
+```text
+http://127.0.0.1:8000/
+```
+
+Swagger documentation:
+
+```text
+http://127.0.0.1:8000/docs
+```
+
+---
+
+# 📋 List Project Types
+
+To see all available generators:
+
+```bash
+projectstarter list
+```
+
+Example:
+
+```text
+Available project types:
+
+  python
+  django
+  flask
+  fastapi
+```
+
+---
+
+# ℹ️ Project Information
+
+Use the `info` command to see information about a generator.
+
+Example:
+
+```bash
+projectstarter info django
+```
+
+Example output:
+
+```text
+Django
+──────────────────────────────
+Description: Python web framework
+Virtual environment: Yes
+Automatic installation: Yes
+
+Run:
+    python manage.py runserver
+```
+
+You can also check other project types:
+
+```bash
+projectstarter info python
+projectstarter info flask
+projectstarter info fastapi
+```
+
+---
+
+# 🩺 Doctor
+
+ProjectStarter includes a built-in diagnostic command:
+
+```bash
+projectstarter doctor
+```
+
+It checks:
+
+- Python
+- Project registry
+- Available generators
+- Project information
+
+Example:
+
+```text
+ProjectStarter Doctor
+──────────────────────────────
+✓ Python
+  Version: 3.x.x
+✓ Registry
+✓ Generators (4)
+  - python
+  - django
+  - flask
+  - fastapi
+✓ Project Info
+  All project information is available.
+
+Everything looks good! ✓
+```
+
+---
+
+# 🧪 Testing ProjectStarter
+
+ProjectStarter uses `pytest` for automated testing.
+
+Install pytest for development:
+
+```bash
+python -m pip install pytest
+```
+
+Run all tests:
+
+```bash
+python -m pytest
+```
+
+The test suite covers:
+
+- Project name validation
+- Generator registry
+- Project information
+- Python project generation
+- Django project generation
+- Flask project generation
+- FastAPI project generation
+- CLI commands
+- Interactive project creation
+- Doctor command
+
+---
+
+# 🏗️ ProjectStarter Development Structure
+
+The ProjectStarter source code is organized as follows:
+
+```text
+projectstarter/
+├── projectstarter/
+│   ├── __init__.py
+│   ├── cli.py
+│   ├── doctor.py
+│   ├── generator.py
+│   ├── registry.py
+│   └── utils.py
+│
+├── templates/
+│   └── python/
+│       └── main.py
+│
+├── tests/
+│   ├── test_cli.py
+│   ├── test_generator.py
+│   ├── test_registry.py
+│   └── test_utils.py
+│
+├── README.md
+├── LICENSE
+└── pyproject.toml
+```
+
+## Main Components
+
+### `cli.py`
+
+Handles the command-line interface and commands such as:
+
+```text
+create
+list
+info
+doctor
+--version
+```
+
+### `generator.py`
+
+Contains the project generation logic for:
+
+- Python
+- Django
+- Flask
+- FastAPI
+
+It also handles virtual environment creation and dependency installation for supported frameworks.
+
+### `registry.py`
+
+Contains the registered project generators and project information.
+
+### `utils.py`
+
+Contains utility functions such as project-name validation.
+
+### `doctor.py`
+
+Provides the `projectstarter doctor` diagnostic command.
+
+### `tests/`
+
+Contains the automated test suite.
+
+---
+
+# ➕ Adding a New Generator
+
+ProjectStarter is designed so that new project types can be added to the generator system.
+
+A new generator generally needs:
+
+1. A generator function in `generator.py`.
+2. Registration in `registry.py`.
+3. Project information in `PROJECT_INFO`.
+4. Tests in `tests/test_generator.py`.
+5. CLI tests when necessary.
+6. Documentation in this README.
+
+This keeps the CLI organized and makes the tool easier to extend.
+
+---
+
+# 🔐 Project Name Rules
+
+ProjectStarter validates project names before creating projects.
+
+Valid examples:
+
+```text
+myproject
+my_project
+project123
+```
+
+Invalid examples:
+
+```text
+my-project
+my project
+123project
+```
+
+Project names must use letters, numbers, and underscores and must not start with a number.
+
+---
+
+# 👨‍💻 Author
+
+**Mohamed Ali**
+
+ProjectStarter was created and is maintained by Mohamed Ali.
+
+## 📞 Contact
+
+For questions, suggestions, bug reports, or contributions, contact the project maintainer through GitHub.
+
+- GitHub: https://github.com/hamada-cool
+- Project Repository: https://github.com/hamada-cool/projectstarter
+- Bug Reports / Issues: https://github.com/hamada-cool/projectstarter/issues
+- Email: `mohamedali32947@gmail.com`
+- Phone / WhatsApp: `+918341391506` & `+249919532947`
+
+You can also open a GitHub Issue if you find a bug or have an idea for improving ProjectStarter.
+
+---
+
+# 🤝 Contributing
+
+Contributions, bug reports, suggestions, and improvements are welcome.
+
+Before submitting changes:
+
+1. Create a branch for your change.
+2. Make your changes.
+3. Run the test suite.
+4. Make sure all tests pass.
+5. Open a pull request.
+
+Run tests with:
+
+```bash
+python -m pytest
+```
+
+---
+
+# 📄 License
+
+ProjectStarter is licensed under the **MIT License**.
+
+See the `LICENSE` file for the complete license text.
+
+---
+
+# 🎯 Project Status
+
+ProjectStarter currently supports:
+
+- Python
+- Django
+- Flask
+- FastAPI
+
+The project is under active development, and more generators and features may be added in future releases.
+
+---
+
+## ⭐ Support the Project
+
+If you find ProjectStarter useful, you can support the project by:
+
+- ⭐ Starring the GitHub repository
+- 🐛 Reporting bugs
+- 💡 Suggesting features
+- 🤝 Contributing code
+- 📢 Sharing the project with other developers
+
+---
+
+**ProjectStarter — Start your next Python project faster. 🚀**
+
+Created by **Mohamed Ali**.

projectstarter_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+projectstarter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+projectstarter/cli.py,sha256=la3FKMG-IHtXvezPfrCGvQOmdHDR_HjqRYTDxn9SdaA,4362
+projectstarter/doctor.py,sha256=PUbIJlscjrZ0ygYMnrXet3ZRSVf27kq0bV9I5FCRE5Y,728
+projectstarter/generator.py,sha256=E9MN0Dsj1zOMDbQc_1xFypM0qcuDpHSBh2IghHomlRo,8695
+projectstarter/registry.py,sha256=iPCSDNe-kx4_xpQNNfruTMlmQHqcZc2mXc0Q__INR0A,1142
+projectstarter/utils.py,sha256=ynnZaePI8WHJiSMK3UAoN4KWtewJ3m7su51Mi2KvjSI,238
+projectstarter_cli-0.1.0.dist-info/licenses/LICENSE,sha256=BUUmY_xjQwdENt5OLI0QO1Q_ctwJUM0xz-2Aj4G1vcM,1087
+projectstarter_cli-0.1.0.dist-info/METADATA,sha256=tDG5bq0oZJyDFCCaV28n4ikfURNZ5yMDbuFtzQ_YSPg,12352
+projectstarter_cli-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+projectstarter_cli-0.1.0.dist-info/entry_points.txt,sha256=yHK-APrWsPY-8sod6aDLVFyJHB0MjFc3lFUHqG63JJE,59
+projectstarter_cli-0.1.0.dist-info/top_level.txt,sha256=ICKAYB4LSinvDfQ63-WcbOo4pM8zFsKugY7O0o1Ekdc,15
+projectstarter_cli-0.1.0.dist-info/RECORD,,

projectstarter_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

projectstarter_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+projectstarter = projectstarter.cli:main

projectstarter_cli-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mohamed Ali
+
+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.

projectstarter_cli-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+projectstarter