ntc-dev-kit 1.0.5__tar.gz → 1.0.6__tar.gz

{ntc_dev_kit-1.0.5/ntc_dev_kit.egg-info → ntc_dev_kit-1.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ntc-dev-kit
-Version: 1.0.5
+Version: 1.0.6
 Summary: Nexent Toolkit Console - A CLI tool for scaffolding Django REST Framework, React, Next.js, and Flutter projects
 Home-page: https://github.com/nexent/ntc
 Author: Nexent

{ntc_dev_kit-1.0.5/ntc-main → ntc_dev_kit-1.0.6/ntc}/main.py

@@ -1,8 +1,8 @@
 """Development launcher for ntc.
 
 Run directly without pip install:
-    python ntc-main/main.py
-    python ntc-main/main.py doctor
+    python ntc/main.py
+    python ntc/main.py doctor
 """
 import sys
 import os

ntc_dev_kit-1.0.6/ntc/templates/drf_structure/drf_structure.md

@@ -0,0 +1,83 @@
+Project/
+├── .env
+├── .gitignore
+├── manage.py
+├── requirements.txt
+├── docker-compose.yml
+├── Dockerfile.
+├── captain-definition.
+├── README.md
+├── {project_name}/
+│   ├── __init__.py
+│   ├── asgi.py
+│   ├── wsgi.py
+│   ├── schema.py
+│   ├── urls.py
+│   ├── celery.py
+│   ├── settings/
+│   │   ├── __init__.py
+│   │   ├── base.py
+│   │   ├── dev.py
+│   │   └── prod.py
+├── apps/
+│   ├── common/
+│   │   ├── models.py
+│   │   ├── serializers/
+│   │   ├── services/
+│   │   ├── tests/
+│   ├── app/
+│   │   ├── __init__.py
+│   │   ├── permissions/
+│   │   ├── serializers/
+│   │   ├── selectors/
+│   │   ├── services/
+│   │   ├── socket/
+│   │   ├── tasks/
+│   │   ├── tests/
+│   │   ├── admin.py
+│   │   ├── apps.py
+│   │   ├── models.py
+│   │   ├── urls.py
+│   │   └── views.py
+│   └── app2/
+│       ├── __init__.py
+│       ├── permissions/
+│       ├── serializers/
+│       ├── selectors/
+│       ├── services/
+│       ├── socket/
+│       ├── tasks/
+│       ├── tests/
+│       ├── admin.py
+│       ├── apps.py
+│       ├── models.py
+│       ├── urls.py
+│       └── views.py
+├── core/
+│   ├── __init__.py
+│   ├── pagination.py
+│   ├── base_model.py
+│   ├── response_wrapper.py
+│   ├── permissions/
+│   ├── exceptions/
+│   ├── signals/
+│   ├── utils/
+│   ├── middlewares/
+│   ├── services/
+│   │   ├── __init__.py
+│   │   ├── azure/
+│   │   │   ├── __init__.py
+│   │   │   ├── email/
+│   │   │   ├── sms/
+│   │   │   ├── storage/
+│   │   │   ├── test.py
+│   │   ├── aws/
+│   │   │   ├── __init__.py
+│   │   │   ├── email/
+│   │   │   ├── sms/
+│   │   │   ├── storage/
+│   │   │   ├── test.py
+│   ├── logging/
+│   │   ├── __init__.py
+│   │   ├── formatter.py
+│   │   ├── logger.py

ntc_dev_kit-1.0.6/ntc/templates/drf_structure/structure.json

@@ -0,0 +1,126 @@
+{
+  ".env": { "template": "templates/root/django_env.txt" },
+  ".gitignore": { "template": "templates/root/gitignore.txt" },
+  "requirements.txt": { "template": "templates/root/django_requirements.txt" },
+  "CLAUDE.md": { "template": "templates/CLAUDE.md" },
+  "Dockerfile": { "template": "templates/docker/Dockerfile" },
+  "docker-compose.yml": { "template": "templates/docker/docker-compose.yml" },
+  ".knowledge": {
+    "knowledge_structure.md": {
+      "template": "templates/knowledge/knowledge_structure.md"
+    },
+    "knowledge_description.md": {
+      "template": "templates/knowledge/knowledge_description.md"
+    },
+    "knowledge_design_pattern.md": {
+      "template": "templates/knowledge/knowledge_design_pattern.md"
+    }
+  },
+  ".entry": {
+    "start_core_backend.sh": {
+      "template": "templates/.entry/start_core_backend.sh"
+    },
+    "start_tasks_backend.sh": {
+      "template": "templates/.entry/start_tasks_backend.sh"
+    }
+  },
+  "config": {
+    "gunicorn_config.py": {
+      "template": "templates/config/gunicorn_config.py"
+    },
+    "http.conf": { "template": "templates/config/http.conf" }
+  },
+  "manage.py": { "template": "templates/root/manage.py" },
+  "apps": {
+    "__init__.py": "",
+    "common": {
+      "__init__.py": "",
+      "apps.py": { "template": "templates/apps/common_apps.py" },
+      "models.py": { "template": "templates/apps/common_models.py" },
+      "serializers": {
+        "__init__.py": ""
+      },
+      "services": {
+        "__init__.py": ""
+      },
+      "tests": {
+        "__init__.py": ""
+      }
+    }
+  },
+  "core": {
+    "__init__.py": "",
+    "pagination.py": { "template": "templates/core/pagination.py" },
+    "base_model.py": { "template": "templates/core/base_model.py" },
+    "response_wrapper.py": { "template": "templates/core/response_wrapper.py" },
+    "permissions": {
+      "__init__.py": ""
+    },
+    "exceptions": {
+      "__init__.py": ""
+    },
+    "signals": {
+      "__init__.py": ""
+    },
+    "utils": {
+      "__init__.py": ""
+    },
+    "middlewares": {
+      "__init__.py": ""
+    },
+    "services": {
+      "__init__.py": "",
+      "object_storage.py": { "template": "templates/core/services/object_storage.py" },
+      "azure": {
+        "__init__.py": "",
+        "email": {
+          "__init__.py": "",
+          "backend.py": { "template": "templates/core/services/azure/email/backend.py" },
+          "client.py": { "template": "templates/core/services/azure/email/client.py" },
+          "notifier.py": { "template": "templates/core/services/azure/email/notifier.py" }
+        },
+        "sms": {
+          "__init__.py": ""
+        },
+        "storage": {
+          "__init__.py": ""
+        }
+      },
+      "aws": {
+        "__init__.py": "",
+        "email": {
+          "__init__.py": ""
+        },
+        "sms": {
+          "__init__.py": ""
+        },
+        "storage": {
+          "__init__.py": ""
+        }
+      }
+    },
+    "logging": {
+      "__init__.py": "",
+      "formatter.py": { "template": "templates/core/formatter.py" },
+      "logger.py": { "template": "templates/core/logger.py" }
+    }
+  },
+  "{project_name}": {
+    "__init__.py": "",
+    "commands": {
+      "__init__.py": "",
+      "create_app.py": { "template": "templates/django_project/management_command.py" }
+    },
+    "asgi.py": { "template": "templates/django_project/asgi.py" },
+    "wsgi.py": { "template": "templates/django_project/wsgi.py" },
+    "urls.py": { "template": "templates/django_project/urls.py" },
+    "schema.py": { "template": "templates/django_project/schema.py" },
+    "celery.py": { "template": "templates/django_project/celery.py" },
+    "settings": {
+      "__init__.py": "",
+      "base.py": { "template": "templates/django_project/django_settings.txt" },
+      "dev.py": { "template": "templates/django_project/dev_settings.py" },
+      "prod.py": { "template": "templates/django_project/prod_settings.py" }
+    }
+  }
+}

ntc_dev_kit-1.0.6/ntc/templates/drf_structure/templates/.entry/start_core_backend.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+# Ensure timezone is correctly set
+export TZ=Africa/Dar_es_Salaam
+
+# Create logs directory if it doesn't exist
+mkdir -p logs
+
+echo "Starting backend services..."
+echo "Logs will be shown in terminal and saved to log files"
+
+# Start nginx
+echo "Starting nginx..."
+nginx -g 'daemon off;' 2>&1 | tee logs/nginx.log &
+NGINX_PID=$!
+
+# Start gunicorn
+echo "Starting gunicorn..."
+gunicorn -c config/gunicorn_config.py {project_name}.asgi:application 2>&1 | tee logs/gunicorn.log &
+GUNICORN_PID=$!
+
+echo "Backend services started!"
+echo "  - Nginx PID: $NGINX_PID"
+echo "  - Gunicorn PID: $GUNICORN_PID"
+
+# Function to cleanup on exit
+cleanup() {
+    echo "Stopping all backend processes..."
+    kill $NGINX_PID $GUNICORN_PID 2>/dev/null
+    exit 0
+}
+
+# Set trap to cleanup on script exit
+trap cleanup SIGINT SIGTERM
+
+# Keep script running
+wait

ntc_dev_kit-1.0.6/ntc/templates/drf_structure/templates/.entry/start_tasks_backend.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+# Ensure timezone is correctly set
+export TZ=Africa/Dar_es_Salaam
+
+# Create logs directory if it doesn't exist
+mkdir -p logs
+
+echo "Starting Celery worker..."
+echo "Logs will be shown in terminal and saved to log files"
+
+# Start Celery worker
+celery -A {project_name} worker -l INFO 2>&1 | tee logs/celery.log &
+CELERY_PID=$!
+
+echo "Celery worker started!"
+echo "  - Celery PID: $CELERY_PID"
+
+# Function to cleanup on exit
+cleanup() {
+    echo "Stopping Celery worker..."
+    kill $CELERY_PID 2>/dev/null
+    exit 0
+}
+
+# Set trap to cleanup on script exit
+trap cleanup SIGINT SIGTERM
+
+# Keep script running
+wait

ntc_dev_kit-1.0.6/ntc/templates/drf_structure/templates/CLAUDE.md

@@ -0,0 +1,194 @@
+# AI Agent Instructions for NTC-Generated Django Projects
+
+This document provides specific instructions for AI agents (Claude, GPT, etc.) working with NTC-generated Django REST Framework projects.
+
+## 📖 Knowledge Base Reading Order
+
+When first approaching this codebase, AI agents should read the knowledge files in this order:
+
+1. **CLAUDE.md** (this file) - AI agent specific instructions
+2. **knowledge/knowledge_structure.md** - Project structure and organization
+3. **knowledge/knowledge_description.md** - Architecture overview and technical stack
+4. **knowledge/knowledge_design_pattern.md** - Design patterns and coding conventions
+
+## 🤖 AI Agent Guidelines
+
+### Before Making Changes
+
+1. **Read the Knowledge Base**: Always read the knowledge files before making any changes to understand the project structure and conventions.
+
+2. **Understand the NTC Structure**: This project follows the NTC (Nexent Toolkit Console) structure with specific patterns for apps, services, selectors, and core utilities.
+
+3. **Check Existing Implementations**: Before adding new features, check if similar implementations already exist in `core/` or `apps/common/`.
+
+### Code Modification Rules
+
+1. **Follow Service/Selector Pattern**: 
+   - Views should only handle HTTP requests/responses
+   - Business logic goes in `services/`
+   - Data querying goes in `selectors/`
+   - Never put business logic in views
+
+2. **Use Standardized Responses**: Always use `success_response()` and `error_response()` from `core.response_wrapper` for consistent API responses.
+
+3. **Inherit from Base Models**: Use `TimeStampedModel` from `apps.common.models` or `BaseModel` from `core.base_model` for automatic timestamp fields.
+
+4. **Use Environment Variables**: All configuration should use environment variables via `django-environ`, never hardcode values.
+
+5. **Follow Naming Conventions**:
+   - Models: `PascalCase` (e.g., `UserProfile`)
+   - Functions/Views: `snake_case` (e.g., `create_user_view`)
+   - URLs: `kebab-case` (e.g., `/api/user-profile/`)
+   - Classes: `PascalCase`
+   - Variables: `snake_case`
+   - Constants: `UPPER_SNAKE_CASE`
+
+### External Service Integration
+
+1. **Azure Communication Services (Email)**:
+   - Use `core.services.azure.email.send_template_email()` for sending emails
+   - Email templates should be in Django templates directory
+   - Supports HTML and plain text versions
+   - Falls back to console backend in development if credentials not configured
+
+2. **Cloudflare R2 Storage**:
+   - Use `core.services.object_storage.ObjectStorageService` for file operations
+   - Supports file upload, download, delete, and URL-based uploads
+   - Validates file types and sizes
+   - Handles image dimension extraction
+
+3. **Sentry Error Tracking**:
+   - Automatically configured via `SENTRY_DSN` environment variable
+   - Captures all log levels and errors
+   - Includes performance monitoring
+
+### Docker and Deployment
+
+1. **Production-Ready Docker Setup**:
+   - Uses Python 3.12-slim base image
+   - Includes nginx reverse proxy with WebSocket support
+   - Uses uvicorn workers with gunicorn for async performance
+   - Entry scripts in `.entry/` directory manage service startup
+
+2. **Configuration Files**:
+   - `config/gunicorn_config.py` - Gunicorn configuration
+   - `config/http.conf` - Nginx configuration
+   - `.entry/start_core_backend.sh` - Core backend startup script
+   - `.entry/start_tasks_backend.sh` - Celery worker startup script
+
+### Settings Configuration
+
+1. **Environment-Based Settings**:
+   - `settings/base.py` - Shared settings
+   - `settings/dev.py` - Development settings
+   - `settings/prod.py` - Production settings
+   - ASGI and WSGI use production settings by default in Docker
+
+2. **Key Environment Variables**:
+   - `DEBUG` - Set to `False` in production
+   - `SENTRY_DSN` - Sentry error tracking DSN
+   - `AZURE_COMMUNICATION_ENDPOINT` - Azure email endpoint
+   - `AZURE_COMMUNICATION_ACCESS_KEY` - Azure email access key
+   - `R2_ACCOUNT_ID`, `R2_ACCESS_KEY_ID`, `R2_SECRET_ACCESS_KEY` - Cloudflare R2 credentials
+   - `R2_PUBLIC_BASE_URL` - Public URL for R2 bucket
+
+### Common Tasks
+
+1. **Creating New Apps**: Use `ntc create app app_name` command which creates the proper structure automatically.
+
+2. **Adding New Services**: 
+   - Place in `core/services/` for project-wide services
+   - Place in `apps/app_name/services/` for app-specific services
+   - Follow the existing service patterns in `core/services/azure/`
+
+3. **Adding Database Models**:
+   - Inherit from `TimeStampedModel` or `BaseModel`
+   - Add proper field types and constraints
+   - Create and run migrations: `python manage.py makemigrations` and `python manage.py migrate`
+
+4. **Adding API Endpoints**:
+   - Create views in `apps/app_name/views.py`
+   - Add URL patterns in `apps/app_name/urls.py`
+   - Create serializers in `apps/app_name/serializers/`
+   - Use response wrappers for consistent responses
+
+### Testing
+
+1. **Test Structure**: Each app should have a `tests/` directory with test files mirroring the app structure.
+
+2. **Test Utilities**: Use `apps.common.tests` for shared test utilities and fixtures.
+
+3. **Run Tests**: Use `python manage.py test` to run the test suite.
+
+### Security Considerations
+
+1. **Never Commit Secrets**: Environment variables should never be committed to the repository.
+
+2. **Use JWT for Authentication**: All API endpoints requiring authentication should use JWT tokens.
+
+3. **Validate Inputs**: Always validate user inputs using serializers and service-level validation.
+
+4. **SQL Injection Prevention**: Use Django ORM queries, never raw SQL with user input.
+
+### When to Ask for Clarification
+
+1. If you're unsure about the NTC structure or conventions
+2. If you need to add a new external service integration
+3. If you're modifying core framework files (`core/` directory)
+4. If you're changing the Docker configuration
+5. If you're modifying the authentication system
+
+## 🎯 Quick Reference
+
+### Import Patterns
+```python
+# Response wrapper
+from core.response_wrapper import success_response, error_response
+
+# Base models
+from apps.common.models import TimeStampedModel
+from core.base_model import BaseModel
+
+# Pagination
+from core.pagination import StandardResultsSetPagination
+
+# Azure email
+from core.services.azure.email import send_template_email
+
+# Object storage
+from core.services.object_storage import ObjectStorageService
+```
+
+### Common Patterns
+```python
+# Success response
+return success_response(data={"id": 123}, message="Created successfully")
+
+# Error response
+return error_response(message="Invalid input", code=400)
+
+# Send email
+send_template_email(
+    subject="Welcome",
+    to="user@example.com",
+    template="welcome_email",
+    context={"name": "John"}
+)
+
+# Upload file to R2
+storage = ObjectStorageService()
+public_url, key = storage.upload_file(uploaded_file, "path/to/file")
+```
+
+## 📝 Additional Resources
+
+- Django REST Framework Documentation: https://www.django-rest-framework.org/
+- Celery Documentation: https://docs.celeryproject.org/
+- Azure Communication Services: https://docs.microsoft.com/azure/communication-services/
+- Cloudflare R2 Documentation: https://developers.cloudflare.com/r2/
+- Sentry Documentation: https://docs.sentry.io/
+
+---
+
+**Last Updated**: 2026-05-09
+**Template Version**: Enhanced with Docker, Azure Email, Sentry, and R2 Storage

ntc_dev_kit-1.0.6/ntc/templates/drf_structure/templates/README.md

@@ -0,0 +1,117 @@
+# NTC Django REST Framework Templates
+
+This directory contains organized template files for generating Django REST Framework projects with the NTC structure.
+
+## 📁 Directory Structure
+
+```
+templates/
+├── root/                   # Root project files
+│   ├── README.md          # Project documentation template
+│   ├── manage.py          # Django management script
+│   ├── gitignore.txt      # Git ignore patterns
+│   ├── django_env.txt     # Environment variables template
+│   └── django_requirements.txt  # Python dependencies
+├── django_project/        # Django project configuration
+│   ├── asgi.py           # ASGI application entry point
+│   ├── wsgi.py           # WSGI application entry point
+│   ├── celery.py         # Celery task configuration
+│   ├── schema.py         # API schema configuration
+│   ├── urls.py           # Main URL routing
+│   ├── django_settings.txt  # Base Django settings
+│   ├── dev_settings.py   # Development settings
+│   ├── prod_settings.py  # Production settings
+│   └── management_command.py  # Custom management command
+├── apps/                  # Django app templates
+│   ├── app_admin.py      # Django admin configuration
+│   ├── app_apps.py       # App configuration
+│   ├── app_models.py     # Model definitions
+│   ├── app_urls.py       # App URL patterns
+│   ├── app_views.py      # API views with test endpoint
+│   ├── common_apps.py    # Common app configuration
+│   └── common_models.py  # Shared base models
+├── core/                  # Core framework utilities
+│   ├── base_model.py     # Abstract base model
+│   ├── pagination.py     # DRF pagination classes
+│   ├── response_wrapper.py  # Standardized API responses
+│   ├── formatter.py      # Logging formatter
+│   └── logger.py         # Logger configuration
+├── docker/               # Docker and deployment
+│   ├── Dockerfile        # Docker build instructions
+│   ├── docker-compose.yml  # Local development environment
+│   └── captain-definition  # CapRover deployment config
+└── knowledge/            # AI documentation
+    ├── knowledge_structure.md     # Project structure guide
+    ├── knowledge_description.md   # Project overview
+    └── knowledge_design_pattern.md  # Design patterns guide
+```
+
+## 🎯 Template Categories
+
+### **Root Templates** (`root/`)
+Files that go in the project root directory:
+- Project documentation and setup files
+- Environment configuration
+- Dependencies and requirements
+
+### **Django Project Templates** (`django_project/`)
+Django project configuration files:
+- ASGI/WSGI application entry points
+- Settings modules (base, dev, prod)
+- URL routing and API schema
+- Custom management commands
+
+### **App Templates** (`apps/`)
+Django application templates:
+- Standard Django app files (admin, apps, models, urls, views)
+- Common/shared app components
+- Pre-configured with NTC patterns
+
+### **Core Templates** (`core/`)
+Framework utilities and extensions:
+- Base models and pagination
+- Response wrappers and logging
+- Reusable core components
+
+### **Docker Templates** (`docker/`)
+Containerization and deployment:
+- Docker build and compose files
+- Deployment configurations
+
+### **Knowledge Templates** (`knowledge/`)
+AI-friendly documentation:
+- Project structure documentation
+- Design patterns and conventions
+- Development guidelines
+
+## 🔧 Usage
+
+Templates are referenced in `structure.json` using paths like:
+```json
+{
+  "file.py": { "template": "drf_structure/templates/category/template_name.py" }
+}
+```
+
+## 📝 Template Variables
+
+Templates support variable replacement:
+- `{project_name}` - Project name
+- `{app_name}` - App name (for app templates)
+- `{app_name_title}` - Titleized app name
+- `{secret_key}` - Generated secret key
+
+## 🎨 Benefits of Organization
+
+1. **Maintainability**: Easy to find and update specific templates
+2. **Clarity**: Clear separation of concerns by category
+3. **Scalability**: Easy to add new templates in appropriate categories
+4. **Consistency**: Organized structure matches generated project structure
+5. **Documentation**: Clear understanding of template purposes
+
+## 🔄 Adding New Templates
+
+1. Place template in appropriate category directory
+2. Update `structure.json` with correct path
+3. Add variable replacement if needed
+4. Update this README if adding new categories

ntc_dev_kit-1.0.6/ntc/templates/drf_structure/templates/config/http.conf

@@ -0,0 +1,33 @@
+server {
+    listen 80;
+    server_name localhost;
+
+    # WebSocket endpoint
+    location /ws/ {
+        proxy_pass http://0.0.0.0:8000;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection "upgrade";
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+        
+        # WebSocket timeout settings
+        proxy_read_timeout 86400;
+        proxy_send_timeout 86400;
+    }
+
+    location / {
+        proxy_pass http://0.0.0.0:8000;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        # Always tell Django the original scheme is HTTPS (handled by outer proxy/CDN)
+        proxy_set_header X-Forwarded-Proto https;
+        client_max_body_size 5G;
+        proxy_connect_timeout 300s;
+        proxy_send_timeout 300s;
+        proxy_read_timeout 300s;
+    }
+}