quickscale-core 0.57.0__tar.gz

quickscale_core-0.57.0/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.1
+Name: quickscale-core
+Version: 0.57.0
+Summary: Core scaffolding and utilities for QuickScale Django project generator
+Home-page: https://github.com/Experto-AI/quickscale
+License: Apache-2.0
+Keywords: django,scaffolding,project-generator,saas
+Author: Experto AI
+Author-email: victor@experto.ai
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: Jinja2 (>=3.1.0,<4.0.0)
+Project-URL: Documentation, https://github.com/Experto-AI/quickscale/tree/main/docs
+Project-URL: Repository, https://github.com/Experto-AI/quickscale

quickscale_core-0.57.0/pyproject.toml

@@ -0,0 +1,111 @@
+[tool.poetry]
+name = "quickscale-core"
+version = "0.57.0"
+description = "Core scaffolding and utilities for QuickScale Django project generator"
+authors = ["Experto AI <victor@experto.ai>"]
+license = "Apache-2.0"
+keywords = ["django", "scaffolding", "project-generator", "saas"]
+homepage = "https://github.com/Experto-AI/quickscale"
+repository = "https://github.com/Experto-AI/quickscale"
+documentation = "https://github.com/Experto-AI/quickscale/tree/main/docs"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Framework :: Django",
+    "Framework :: Django :: 4.2",
+    "Framework :: Django :: 5.0",
+]
+packages = [{include = "quickscale_core", from = "src"}]
+include = [
+    "src/quickscale_core/generator/templates/**/*",
+]
+
+[tool.poetry.dependencies]
+python = "^3.10"
+Jinja2 = "^3.1.0"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.4.0"
+pytest-cov = "^4.1.0"
+ruff = "^0.6.0"
+mypy = "^1.8.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = [
+    "--strict-markers",
+    "--strict-config",
+    "--cov=quickscale_core",
+    "--cov-report=term-missing",
+    "--cov-report=html",
+]
+
+[tool.coverage.run]
+omit = [
+    "*/templates/*.j2",
+    "*/templates/**/*.j2",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "N",  # pep8-naming
+    "UP", # pyupgrade
+    "D",  # docstring rules
+]
+ignore = [
+    "D100",  # Missing docstring in public module
+    "D101",  # Missing docstring in public class
+    "D102",  # Missing docstring in public method
+    "D103",  # Missing docstring in public function
+    "D105",  # Missing docstring in magic method
+    "D107",  # Missing docstring in __init__
+    "D203",  # 1 blank line required before class docstring (incompatible with D211)
+    "D212",  # Multi-line docstring summary should start at the first line (incompatible with D213)
+    "D400",  # First line should end with a period
+    "D415",  # First line should end with a period, question mark, or exclamation point
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["quickscale_core"]
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+warn_unreachable = true
+strict_equality = true
+show_error_codes = true
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+disallow_untyped_defs = false
+check_untyped_defs = false
+

quickscale_core-0.57.0/src/quickscale_core/__init__.py

@@ -0,0 +1,5 @@
+"""QuickScale Core Package - Foundation for Django project scaffolding and generation."""
+
+from quickscale_core.version import VERSION, __version__
+
+__all__ = ["__version__", "VERSION"]

quickscale_core-0.57.0/src/quickscale_core/_version.py

@@ -0,0 +1,2 @@
+# Auto-generated by scripts/version_tool.sh
+__version__ = "0.57.0"

quickscale_core-0.57.0/src/quickscale_core/generator/__init__.py

@@ -0,0 +1,10 @@
+"""
+QuickScale Generator Package
+
+Template-based Django project generator for QuickScale.
+MVP: Simple Jinja2 template rendering for production-ready Django starters.
+"""
+
+from quickscale_core.generator.generator import ProjectGenerator
+
+__all__ = ["ProjectGenerator"]

quickscale_core-0.57.0/src/quickscale_core/generator/generator.py

@@ -0,0 +1,181 @@
+"""Project generator implementation"""
+
+import os
+import shutil
+import tempfile
+from pathlib import Path
+
+from jinja2 import Environment, FileSystemLoader
+
+from quickscale_core.utils.file_utils import (
+    ensure_directory,
+    validate_project_name,
+    write_file,
+)
+
+
+class ProjectGenerator:
+    """Generate Django projects from templates"""
+
+    def __init__(self, template_dir: Path | None = None):
+        """Initialize generator with template directory"""
+        if template_dir is None:
+            # Try to find templates in development environment first
+            import quickscale_core
+
+            package_dir = Path(quickscale_core.__file__).parent
+
+            # Check if we're in development (source directory exists)
+            dev_template_dir = package_dir / "generator" / "templates"
+            if dev_template_dir.exists():
+                template_dir = dev_template_dir
+            else:
+                # Fall back to package templates (should be included)
+                template_dir = package_dir / "templates"
+
+                # If package templates don't exist, try to find source templates
+                # by walking up from the current file location
+                if not template_dir.exists():
+                    current_file = Path(__file__)
+                    # Try common development layouts
+                    possible_paths = [
+                        current_file.parent / "templates",  # Same directory
+                        current_file.parent.parent / "generator" / "templates",  # Parent
+                        Path.cwd()
+                        / "quickscale_core"
+                        / "src"
+                        / "quickscale_core"
+                        / "generator"
+                        / "templates",  # From repo root
+                    ]
+
+                    for path in possible_paths:
+                        if path.exists():
+                            template_dir = path
+                            break
+
+        # Validate template directory exists
+        if not template_dir.exists():
+            raise FileNotFoundError(f"Template directory not found: {template_dir}")
+
+        self.template_dir = template_dir
+        self.env = Environment(
+            loader=FileSystemLoader(str(template_dir), followlinks=True),
+            keep_trailing_newline=True,
+        )
+
+    def generate(self, project_name: str, output_path: Path) -> None:
+        """
+        Generate Django project from templates
+
+        Args:
+            project_name: Name of the project (must be valid Python identifier)
+            output_path: Path where project will be created
+
+        Raises:
+            ValueError: If project_name is invalid
+            FileExistsError: If output_path already exists
+            PermissionError: If output_path is not writable
+
+        """
+        # Validate project name
+        is_valid, error_msg = validate_project_name(project_name)
+        if not is_valid:
+            raise ValueError(f"Invalid project name: {error_msg}")
+
+        # Check if output path already exists
+        if output_path.exists():
+            raise FileExistsError(
+                f"Output path already exists: {output_path}. "
+                "Please choose a different name or remove the existing directory."
+            )
+
+        # Check if parent directory is writable
+        parent = output_path.parent
+        if not parent.exists():
+            try:
+                ensure_directory(parent)
+            except (OSError, PermissionError) as e:
+                raise PermissionError(f"Cannot create parent directory {parent}: {e}") from e
+
+        if not os.access(parent, os.W_OK):
+            raise PermissionError(f"Parent directory is not writable: {parent}")
+
+        # Generate project in temporary directory first (atomic creation)
+        temp_dir = Path(tempfile.mkdtemp(prefix=f"quickscale_{project_name}_"))
+
+        try:
+            # Generate project in temp directory
+            self._generate_project(project_name, temp_dir)
+
+            # Move to final location
+            shutil.move(str(temp_dir), str(output_path))
+
+        except Exception as e:
+            # Clean up temp directory on failure
+            if temp_dir.exists():
+                shutil.rmtree(temp_dir, ignore_errors=True)
+            raise RuntimeError(f"Failed to generate project: {e}") from e
+
+    def _generate_project(self, project_name: str, output_path: Path) -> None:
+        """Generate project structure in specified directory"""
+        # Context for template rendering
+        context = {
+            "project_name": project_name,
+        }
+
+        # Map of template files to output files
+        # Format: (template_path, output_path, executable)
+        file_mappings = [
+            # Root level files
+            ("README.md.j2", "README.md", False),
+            ("manage.py.j2", "manage.py", True),
+            ("pyproject.toml.j2", "pyproject.toml", False),
+            ("poetry.lock.j2", "poetry.lock", False),
+            (".gitignore.j2", ".gitignore", False),
+            (".dockerignore.j2", ".dockerignore", False),
+            (".editorconfig.j2", ".editorconfig", False),
+            (".env.example.j2", ".env.example", False),
+            ("Dockerfile.j2", "Dockerfile", False),
+            ("docker-compose.yml.j2", "docker-compose.yml", False),
+            # Project package files
+            ("project_name/__init__.py.j2", f"{project_name}/__init__.py", False),
+            ("project_name/urls.py.j2", f"{project_name}/urls.py", False),
+            ("project_name/wsgi.py.j2", f"{project_name}/wsgi.py", False),
+            ("project_name/asgi.py.j2", f"{project_name}/asgi.py", False),
+            # Settings files
+            (
+                "project_name/settings/__init__.py.j2",
+                f"{project_name}/settings/__init__.py",
+                False,
+            ),
+            ("project_name/settings/base.py.j2", f"{project_name}/settings/base.py", False),
+            ("project_name/settings/local.py.j2", f"{project_name}/settings/local.py", False),
+            (
+                "project_name/settings/production.py.j2",
+                f"{project_name}/settings/production.py",
+                False,
+            ),
+            # Template files
+            ("templates/base.html.j2", "templates/base.html", False),
+            ("templates/index.html.j2", "templates/index.html", False),
+            # Static files
+            ("static/css/style.css.j2", "static/css/style.css", False),
+            # CI/CD and quality tools
+            ("github/workflows/ci.yml.j2", ".github/workflows/ci.yml", False),
+            (".pre-commit-config.yaml.j2", ".pre-commit-config.yaml", False),
+            # Tests
+            ("tests/__init__.py.j2", "tests/__init__.py", False),
+            ("tests/conftest.py.j2", "tests/conftest.py", False),
+            ("tests/test_example.py.j2", "tests/test_example.py", False),
+        ]
+
+        # Render and write all files
+        for template_path, output_file, executable in file_mappings:
+            # Render template
+            template = self.env.get_template(template_path)
+            content = template.render(**context)
+
+            # Write file
+            output_file_path = output_path / output_file
+            write_file(output_file_path, content, executable=executable)

quickscale_core-0.57.0/src/quickscale_core/generator/templates/.dockerignore.j2

@@ -0,0 +1,61 @@
+# Git
+.git
+.gitignore
+.gitattributes
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.venv/
+
+# Django
+*.log
+db.sqlite3
+db.sqlite3-journal
+/media
+/staticfiles
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+*.cover
+.hypothesis/
+
+# Development
+.env
+.env.local
+.env.*.local
+*.env
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Documentation
+*.md
+docs/
+README.md
+LICENSE
+
+# CI/CD
+.github/
+.gitlab-ci.yml
+
+# Other
+*.bak
+*.tmp
+node_modules/
+npm-debug.log*

quickscale_core-0.57.0/src/quickscale_core/generator/templates/.editorconfig.j2

@@ -0,0 +1,33 @@
+# EditorConfig helps maintain consistent coding styles across editors
+# https://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{py,pyi}]
+indent_style = space
+indent_size = 4
+max_line_length = 100
+
+[*.{js,jsx,ts,tsx,json,yml,yaml}]
+indent_style = space
+indent_size = 2
+
+[*.{html,css,scss}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+max_line_length = off
+
+[Makefile]
+indent_style = tab
+
+[*.{bat,cmd}]
+end_of_line = crlf

quickscale_core-0.57.0/src/quickscale_core/generator/templates/.env.example.j2

@@ -0,0 +1,38 @@
+# Django Core Settings
+# SECURITY WARNING: keep the secret key used in production secret!
+# Generate a new secret key for production: python -c 'from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())'
+SECRET_KEY=django-insecure-change-this-in-production-{{ project_name }}
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG=True
+
+# Comma-separated list of allowed hosts
+ALLOWED_HOSTS=localhost,127.0.0.1
+
+# Server Configuration
+# Port for Django development server and Docker containers
+PORT=8000
+
+# Database Configuration
+# Format: postgresql://user:password@host:port/dbname
+# For local development with docker-compose, use:
+DATABASE_URL=postgresql://postgres:postgres@localhost:5432/{{ project_name }}
+
+# Email Configuration (optional)
+# EMAIL_BACKEND=django.core.mail.backends.smtp.EmailBackend
+# EMAIL_HOST=smtp.gmail.com
+# EMAIL_PORT=587
+# EMAIL_USE_TLS=True
+# EMAIL_HOST_USER=your-email@example.com
+# EMAIL_HOST_PASSWORD=your-app-password
+
+# Static and Media Files
+# STATIC_URL=/static/
+# STATIC_ROOT=staticfiles
+# MEDIA_URL=/media/
+# MEDIA_ROOT=media
+
+# Application Settings
+# Add your custom application settings here
+# ENABLE_FEATURE_X=True
+# API_KEY=your-api-key-here

quickscale_core-0.57.0/src/quickscale_core/generator/templates/.gitignore.j2

@@ -0,0 +1,74 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+
+# Virtual Environments (Poetry-managed and manual)
+.venv/
+venv/
+env/
+ENV/
+env.bak/
+venv.bak/
+
+# Django
+*.log
+db.sqlite3
+db.sqlite3-journal
+/media
+/staticfiles
+/static_root
+
+# Environment variables
+.env
+.env.local
+.env.*.local
+*.env
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+*.cover
+.hypothesis/
+.tox/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+*.sublime-project
+*.sublime-workspace
+
+# Build artifacts
+build/
+dist/
+*.egg-info/
+.eggs/
+
+# Database
+*.db
+*.sqlite
+*.sqlite3
+
+# Logs
+logs/
+*.log
+
+# Docker volumes
+postgres_data/
+redis_data/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Other
+*.bak
+*.tmp
+.cache/

quickscale_core-0.57.0/src/quickscale_core/generator/templates/.pre-commit-config.yaml.j2

@@ -0,0 +1,22 @@
+# See https://pre-commit.com for more information
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-json
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: debug-statements
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.0
+    hooks:
+      # Run the linter
+      - id: ruff
+        args: [--fix]
+      # Run the formatter
+      - id: ruff-format

quickscale_core-0.57.0/src/quickscale_core/generator/templates/Dockerfile.j2

@@ -0,0 +1,82 @@
+# syntax=docker/dockerfile:1
+# Multi-stage build for production Django application
+
+# Stage 1: Builder - Install dependencies and build artifacts
+FROM python:3.11-slim as builder
+
+# Set environment variables for Python
+ENV PYTHONUNBUFFERED=1 \
+    PYTHONDONTWRITEBYTECODE=1 \
+    PIP_NO_CACHE_DIR=1 \
+    PIP_DISABLE_PIP_VERSION_CHECK=1
+
+# Install system dependencies required for building Python packages
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    build-essential \
+    libpq-dev \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install Poetry
+RUN pip install poetry==1.7.1
+
+# Set working directory
+WORKDIR /app
+
+# Copy dependency files
+COPY pyproject.toml poetry.lock ./
+
+# Configure Poetry to not create virtual environments (we're in a container)
+RUN poetry config virtualenvs.create false
+
+# Install dependencies (--no-root: don't install project itself, only dependencies)
+RUN poetry install --only main --no-root --no-interaction --no-ansi
+
+# Stage 2: Runtime - Create minimal production image
+FROM python:3.11-slim
+
+# Set environment variables
+ENV PYTHONUNBUFFERED=1 \
+    PYTHONDONTWRITEBYTECODE=1 \
+    DJANGO_SETTINGS_MODULE={{ project_name }}.settings.production
+
+# Port configuration
+ARG PORT=8000
+ENV PORT=${PORT}
+
+# Install runtime dependencies only
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    libpq5 \
+    && rm -rf /var/lib/apt/lists/*
+
+# Create non-root user for security
+RUN groupadd -r django && useradd -r -g django django
+
+# Set working directory
+WORKDIR /app
+
+# Copy installed dependencies from builder stage
+COPY --from=builder /usr/local/lib/python3.11/site-packages /usr/local/lib/python3.11/site-packages
+COPY --from=builder /usr/local/bin /usr/local/bin
+
+# Copy application code
+COPY --chown=django:django . .
+
+# Create necessary directories with correct permissions
+RUN mkdir -p /app/staticfiles /app/media /app/logs && \
+    chown -R django:django /app
+
+# Switch to non-root user
+USER django
+
+# Collect static files
+RUN python manage.py collectstatic --noinput
+
+# Expose port
+EXPOSE ${PORT}
+
+# Health check - verify gunicorn is responding (any response including 404/500 means it's alive)
+HEALTHCHECK --interval=30s --timeout=10s --start-period=40s --retries=3 \
+    CMD python -c "import os, urllib.request; urllib.request.urlopen(f'http://localhost:{os.environ.get(\"PORT\", \"8000\")}/', timeout=5)"
+
+# Run gunicorn
+CMD gunicorn {{ project_name }}.wsgi:application --bind 0.0.0.0:${PORT} --workers 4 --timeout 60 --access-logfile - --error-logfile -