pyapp-cli 0.1.0__tar.gz

pyapp_cli-0.1.0/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.3
+Name: pyapp-cli
+Version: 0.1.0
+Summary: Add your description here
+Requires-Dist: colorama>=0.4.6
+Requires-Dist: fire>=0.7.1
+Requires-Dist: inquirerpy>=0.3.4
+Requires-Dist: pydantic>=2.12.5
+Requires-Python: >=3.12, <4.0
+Description-Content-Type: text/markdown
+
+# PyApp CLI
+
+## About
+
+PyApp CLI is a powerful tool that makes python project setup painless. With this CLI you can easily scaffold FastAPI, Flask or Django project with all necessary dependencies.
+
+## Supported platforms
+
+The CLI can be run on Ubuntu Linux, but it's not guaranteed the CLI will work on other platforms.
+
+## Get started
+
+Before setting up new project, install Python and appropriate package manager you'll use for your project. PyAPP CLI supports following package managers:
+
+- pip
+- poetry
+- uv
+
+Use `main.py init` command to run the CLI:
+
+```bash
+python main.py init              # python interpreter
+poetry run python main.py init   # poetry
+uv run main.py init              # uv
+```
+
+Alertnatively, you can use python3 prefix when running command.
+
+## Contributing
+
+Feel free to open an issue if you have found a bug, have a feature request or you want to expand list of available libraries/frameworks/package managers. You also can open PR if you wish.

pyapp_cli-0.1.0/README.md

@@ -0,0 +1,31 @@
+# PyApp CLI
+
+## About
+
+PyApp CLI is a powerful tool that makes python project setup painless. With this CLI you can easily scaffold FastAPI, Flask or Django project with all necessary dependencies.
+
+## Supported platforms
+
+The CLI can be run on Ubuntu Linux, but it's not guaranteed the CLI will work on other platforms.
+
+## Get started
+
+Before setting up new project, install Python and appropriate package manager you'll use for your project. PyAPP CLI supports following package managers:
+
+- pip
+- poetry
+- uv
+
+Use `main.py init` command to run the CLI:
+
+```bash
+python main.py init              # python interpreter
+poetry run python main.py init   # poetry
+uv run main.py init              # uv
+```
+
+Alertnatively, you can use python3 prefix when running command.
+
+## Contributing
+
+Feel free to open an issue if you have found a bug, have a feature request or you want to expand list of available libraries/frameworks/package managers. You also can open PR if you wish.

pyapp_cli-0.1.0/pyproject.toml

@@ -0,0 +1,19 @@
+[project]
+name = "pyapp-cli"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.12,<4.0"
+dependencies = [
+    "colorama>=0.4.6",
+    "fire>=0.7.1",
+    "inquirerpy>=0.3.4",
+    "pydantic>=2.12.5",
+]
+
+[project.scripts]
+pyapp = "pyapp_cli:main"
+
+[build-system]
+requires = ["uv_build>=0.10.12,<0.11.0"]
+build-backend = "uv_build"

pyapp_cli-0.1.0/src/pyapp_cli/__init__.py

@@ -0,0 +1,8 @@
+import fire
+
+from .generator import ProjectGenerator
+from .logger import Logger
+
+
+def main() -> None:
+    fire.Fire(ProjectGenerator(logger=Logger()))

pyapp_cli-0.1.0/src/pyapp_cli/generator.py

@@ -0,0 +1,209 @@
+import os
+from pathlib import Path
+import shutil
+import subprocess
+import sys
+from typing import Literal
+
+from InquirerPy import prompt
+
+from .logger import Logger
+from .questions import questions
+from .schemas import Answers
+
+venv_dir = ".venv"
+
+
+class ProjectGenerator:
+    # frameworks without built-in CLI for scaffolding the project
+    _framework_packages = set(["FastAPI", "Flask"])
+    _templates_dir = os.path.abspath("templates")
+
+    def __init__(self, logger: Logger) -> None:
+        self._logger = logger
+
+    def init(self):
+        raw_answers = prompt(questions)
+        answers = Answers.model_validate(raw_answers)
+
+        self._create_project_folder(answers.project_path, answers.source_folder)
+
+        if answers.package_manager == "pip":
+            self._ensure_pip_installation()
+        elif answers.package_manager == "poetry":
+            self._ensure_poetry_installation()
+        elif answers.package_manager == "uv":
+            self._ensure_uv_installation()
+
+        if answers.framework == "None" or answers.framework in self._framework_packages:
+            self._create_main_file(answers.source_folder, answers.framework)
+
+        dependencies = answers.libraries
+        if answers.framework != "None":
+            dependencies.append(self._framework_id(answers.framework))
+
+        if answers.package_manager == "pip":
+            self._pip_setup_project(dependencies)
+        elif answers.package_manager == "poetry":
+            self._poetry_setup_project(dependencies)
+        elif answers.package_manager == "uv":
+            self._uv_setup_project(dependencies, answers.python_version)
+
+        if answers.framework == "Django":
+            self._django_setup_project(answers.package_manager, answers.source_folder)
+
+        self._logger.success("Finished! Enjoy the project :)")
+
+    def _framework_id(self, framework: str) -> str:
+        return framework.lower()
+
+    def _missing_dependency_message(self, dependency: str) -> str:
+        return (
+            f"Can't detect installed {dependency}.\n"
+            f"Ensure {dependency} is installed and then run the script again."
+        )
+
+    def _create_project_folder(self, project_path: str, source_folder: str) -> None:
+        Path(project_path).mkdir(exist_ok=True)
+        if source_folder != "root":
+            Path(project_path, source_folder).mkdir(exist_ok=True)
+        os.chdir(project_path)
+        self._logger.log(f"Created folder '{project_path}'")
+
+    def _ensure_pip_installation(self) -> None:
+        pip_exists = shutil.which("pip") is not None
+        if pip_exists:
+            self._logger.success("Detected pip")
+        else:
+            self._logger.error(self._missing_dependency_message("pip"))
+            exit(127)
+
+    def _ensure_poetry_installation(self) -> None:
+        poetry_exists = shutil.which("poetry") is not None
+        if poetry_exists:
+            self._logger.success("Detected Poetry")
+        else:
+            self._logger.error(self._missing_dependency_message("Poetry"))
+            exit(127)
+
+    def _ensure_uv_installation(self) -> None:
+        uv_exists = shutil.which("uv") is not None
+        if uv_exists:
+            self._logger.success("Detected uv")
+        else:
+            self._logger.error(self._missing_dependency_message("uv"))
+            exit(127)
+
+    def _create_main_file(self, source_folder: str, framework: str) -> None:
+        python_file = None
+        if source_folder == "root":
+            python_file = Path("main.py")
+        else:
+            python_file = Path(source_folder, "main.py")
+        python_file.parent.mkdir(parents=True, exist_ok=True)
+        self._logger.log("Added main.py")
+
+        project_template = None
+        try:
+            template_path = os.path.join(
+                self._templates_dir, f"{self._framework_id(framework)}.py"
+            )
+            with open(template_path, "r") as template_file:
+                project_template = template_file.read()
+            self._logger.log(f"Applied {self._framework_id(framework)} template")
+        except FileNotFoundError:
+            pass
+
+        with open(python_file, "w") as f:
+            if project_template is not None:
+                f.write(project_template)
+
+    def _pip_setup_project(self, dependencies: list[str]) -> None:
+        self._logger.log("Creating virtual environment...")
+        subprocess.check_call(
+            [
+                sys.executable,
+                "-m",
+                "venv",
+                os.path.join(venv_dir),
+            ],
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.DEVNULL,
+        )
+
+        if len(dependencies) > 0:
+            self._logger.log("Installing dependencies...")
+            python_executable = os.path.abspath(
+                os.path.join(venv_dir, "bin", "python3")
+            )
+            subprocess.check_call(
+                [python_executable, "-m", "pip", "install", *dependencies],
+            )
+            result = subprocess.run(
+                [python_executable, "-m", "pip", "freeze"],
+                check=True,
+                capture_output=True,
+                text=True,
+            )
+            with open("requirements.txt", "w") as f:
+                f.write(result.stdout)
+            self._logger.success("Saved dependencies to requirements.txt")
+
+    def _poetry_setup_project(self, dependencies: list[str]) -> None:
+        subprocess.check_call(
+            ["poetry", "init", "-n"],
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.DEVNULL,
+        )
+        self._logger.log("Initialized poetry project")
+
+        if len(dependencies) > 0:
+            self._logger.log("Installing dependencies...")
+            custom_env = os.environ.copy()
+            custom_env["POETRY_VIRTUALENVS_IN_PROJECT"] = "true"
+            custom_env["VIRTUAL_ENV"] = os.path.abspath(venv_dir)
+            subprocess.check_call(
+                [
+                    "poetry",
+                    "add",
+                    *dependencies,
+                ],
+                env=custom_env,
+            )
+
+    def _uv_setup_project(self, dependencies: list[str], python_version: str) -> None:
+        subprocess.check_call(
+            ["uv", "init", "--bare", "--no-workspace"],
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.DEVNULL,
+        )
+        self._logger.log("Initialized uv project")
+
+        with open(".python-version", "w") as f:
+            f.write(python_version)
+
+        if len(dependencies) > 0:
+            self._logger.log("Installing dependencies...")
+            subprocess.check_call(
+                [
+                    "uv",
+                    "add",
+                    *dependencies,
+                ],
+            )
+
+    def _django_setup_project(
+        self, package_manager: Literal["pip", "poetry", "uv"], source_folder: str
+    ) -> None:
+        python_executable = os.path.abspath(os.path.join(venv_dir, "bin", "python3"))
+        django_util = [python_executable, "-m", "django"]
+        if package_manager == "uv":
+            django_util = ["uv", "run", "django-admin"]
+        self._logger.log("Initialized Django project")
+
+        if source_folder != "root":
+            os.chdir(source_folder)
+
+        subprocess.check_call(
+            [*django_util, "startproject", "mysite", "."],
+        )

pyapp_cli-0.1.0/src/pyapp_cli/logger.py

@@ -0,0 +1,15 @@
+from colorama import Fore, Style, init
+
+
+class Logger:
+    def __init__(self) -> None:
+        init(autoreset=True)
+
+    def log(self, message: str) -> None:
+        print(Style.DIM + message)
+
+    def success(self, message: str) -> None:
+        print(Fore.GREEN + message)
+
+    def error(self, message: str) -> None:
+        print(Fore.RED + message)

pyapp_cli-0.1.0/src/pyapp_cli/questions.py

@@ -0,0 +1,47 @@
+questions = [
+    {
+        "type": "input",
+        "name": "project_path",
+        "message": "Enter the project path",
+    },
+    {
+        "type": "list",
+        "name": "package_manager",
+        "message": "Choose the package manager",
+        "choices": ["pip", "poetry", "uv"],
+    },
+    {
+        "type": "input",
+        "name": "python_version",
+        "message": "Enter Python version",
+        "default": "3.12",
+    },
+    {
+        "type": "list",
+        "name": "source_folder",
+        "message": "Choose the source code folder (root - project folder)",
+        "choices": ["root", "src", "app"],
+    },
+    {
+        "type": "list",
+        "name": "framework",
+        "message": "Choose the framework",
+        "choices": ["None", "FastAPI", "Flask", "Django"],
+    },
+    {
+        "type": "checkbox",
+        "name": "libraries",
+        "message": "Choose the libraries",
+        "choices": [
+            "gunicorn",
+            "uvicorn",
+            "sqlalchemy",
+            "firebase-admin",
+            "pydantic",
+            "pydantic-settings",
+            "pytest",
+            "pytest-asyncio",
+            "python-dotenv",
+        ],
+    },
+]

pyapp_cli-0.1.0/src/pyapp_cli/schemas.py

@@ -0,0 +1,12 @@
+from typing import Literal
+
+from pydantic import BaseModel
+
+
+class Answers(BaseModel):
+    project_path: str
+    package_manager: Literal["pip", "poetry", "uv"]
+    python_version: str
+    source_folder: Literal["root", "src", "app"]
+    framework: Literal["None", "FastAPI", "Flask", "Django"]
+    libraries: list[str]

pyapp_cli-0.1.0/src/pyapp_cli/templates/fastapi.py

@@ -0,0 +1,8 @@
+from fastapi import FastAPI
+
+app = FastAPI()
+
+
+@app.get("/")
+def read_root():
+    return "Hello, World!"

pyapp_cli-0.1.0/src/pyapp_cli/templates/flask.py

@@ -0,0 +1,8 @@
+from flask import Flask
+
+app = Flask(__name__)
+
+
+@app.get("/")
+def hello_world():
+    return "Hello, World!"