ntc-dev-kit 1.0.0__py3-none-any.whl

ntc/templates/drf_structure/templates/knowledge/knowledge_structure.md

@@ -0,0 +1,151 @@
+# Project Structure - {project_name}
+
+This document describes the complete project structure and organization for AI assistants to understand how to work with this codebase.
+
+## 📁 Root Directory Structure
+
+```
+{project_name}/
+├── .env                    # Environment variables
+├── .gitignore             # Git ignore patterns
+├── .knowledge/            # AI documentation (this directory)
+├── .entry/               # Docker entry scripts
+│   ├── start_core_backend.sh    # Core backend startup
+│   └── start_tasks_backend.sh   # Celery worker startup
+├── config/               # Server configuration files
+│   ├── gunicorn_config.py       # Gunicorn configuration
+│   └── http.conf                # Nginx configuration
+├── manage.py              # Django management script
+├── requirements.txt       # Python dependencies
+├── docker-compose.yml     # Docker composition
+├── Dockerfile            # Docker build instructions
+├── captain-definition    # CapRover deployment config
+├── README.md             # Project documentation
+├── {project_name}/       # Django project configuration
+├── apps/                 # Django applications
+└── core/                 # Core utilities and frameworks
+```
+
+## 🏗️ Django Project Configuration (`{project_name}/`)
+
+```
+{project_name}/
+├── __init__.py
+├── asgi.py               # ASGI application entry point (uses prod settings)
+├── wsgi.py               # WSGI application entry point (uses prod settings)
+├── schema.py             # API schema configuration (OpenAPI/Swagger)
+├── urls.py               # Main URL routing
+├── celery.py             # Celery task configuration
+├── settings/             # Split settings configuration
+│   ├── __init__.py
+│   ├── base.py          # Base settings (shared, includes Azure, Sentry, R2)
+│   ├── dev.py           # Development settings
+│   └── prod.py          # Production settings
+└── management/           # Custom Django management commands
+    └── commands/
+        ├── __init__.py
+        └── create_app.py # NTC app creation command
+```
+
+## 📱 Applications Directory (`apps/`)
+
+```
+apps/
+├── __init__.py
+├── common/               # Shared utilities and base models
+│   ├── __init__.py
+│   ├── apps.py          # App configuration
+│   ├── models.py        # Abstract base models (TimeStampedModel)
+│   ├── serializers/     # Shared serializers
+│   ├── services/        # Shared business logic
+│   └── tests/           # Common tests
+└── [app_name]/          # Individual Django apps (created via `ntc create app`)
+    ├── __init__.py
+    ├── admin.py         # Django admin configuration
+    ├── apps.py          # App configuration
+    ├── models.py        # Data models
+    ├── urls.py          # App-specific URL patterns
+    ├── views.py         # API views and endpoints
+    ├── permissions/     # Custom permissions
+    ├── serializers/     # DRF serializers
+    ├── selectors/       # Data selection logic
+    ├── services/        # Business logic
+    ├── socket/          # WebSocket handlers
+    ├── tasks/           # Celery tasks
+    └── tests/           # App-specific tests
+```
+
+## 🔧 Core Framework (`core/`)
+
+```
+core/
+├── __init__.py
+├── pagination.py         # DRF pagination classes
+├── base_model.py        # Abstract base model with common fields
+├── response_wrapper.py  # Standardized API response utilities
+├── permissions/         # Custom permission classes
+├── exceptions/          # Custom exception handlers
+├── signals/             # Django signals
+├── utils/               # General utilities
+├── middlewares/         # Custom middleware
+├── services/            # External service integrations
+│   ├── object_storage.py # Cloudflare R2 (S3-compatible) storage
+│   ├── azure/          # Azure cloud services
+│   │   └── email/      # Azure Communication Services Email
+│   │       ├── backend.py    # Django email backend
+│   │       ├── client.py     # Azure SDK wrapper
+│   │       └── notifier.py   # High-level email sender
+│   │   ├── sms/        # Azure SMS (placeholder)
+│   │   └── storage/    # Azure Storage (placeholder)
+│   └── aws/            # AWS cloud services
+│       ├── email/      # AWS SES (placeholder)
+│       ├── sms/        # AWS SNS (placeholder)
+│       └── storage/    # AWS S3 (placeholder)
+└── logging/            # Logging configuration
+    ├── formatter.py    # Custom log formatters
+    └── logger.py       # Logger setup
+```
+
+## 🎯 Key Conventions
+
+### File Naming
+- **Models**: `PascalCase` classes in `models.py`
+- **Views**: `snake_case` functions/classes in `views.py`
+- **URLs**: `kebab-case` patterns in `urls.py`
+- **Apps**: `snake_case` directory names
+
+### Import Patterns
+- **Models**: `from apps.common.models import TimeStampedModel`
+- **Response**: `from core.response_wrapper import success_response, error_response`
+- **Pagination**: `from core.pagination import StandardResultsSetPagination`
+
+### URL Structure
+- **App URLs**: `/{app_name}/endpoint/`
+- **API Versioning**: Not implemented (single version)
+- **Admin**: `/admin/`
+- **API Docs**: `/docs/` (Swagger UI)
+
+## 🔄 Development Workflow
+
+1. **Create new app**: `ntc create app app_name`
+2. **Add models**: Edit `apps/app_name/models.py`
+3. **Create migrations**: `python manage.py makemigrations app_name`
+4. **Apply migrations**: `python manage.py migrate`
+5. **Add views**: Edit `apps/app_name/views.py`
+6. **Configure URLs**: Edit `apps/app_name/urls.py`
+7. **Test endpoint**: `GET /app_name/hello/` (auto-created test endpoint)
+
+## 📋 Important Notes for AI
+
+- **Always use the NTC structure** when creating new apps
+- **Follow the Service/Selector pattern** for business logic
+- **Use `success_response()` and `error_response()`** for consistent API responses
+- **Inherit from `TimeStampedModel`** for automatic timestamp fields
+- **Place business logic in `services/`**, not in views
+- **Use `selectors/` for complex data queries**
+- **All new apps are automatically added to `INSTALLED_APPS` and main `urls.py`**
+- **Azure Email**: Use `core.services.azure.email.send_template_email()` for email sending
+- **Object Storage**: Use `core.services.object_storage.ObjectStorageService` for file operations
+- **Docker Setup**: Production-ready with nginx, uvicorn, and entry scripts
+- **Sentry**: Automatically configured via `SENTRY_DSN` environment variable
+- **ASGI/WSGI**: Use production settings (`settings.prod`) by default

ntc/templates/drf_structure/templates/root/README.md

@@ -0,0 +1,307 @@
+# {project_name}
+
+A Django REST Framework project built with **NTC (Nexent Toolkit Console)** structure for scalable, maintainable API development.
+
+---
+
+## 📋 Project Description
+
+<!-- Add your project-specific description here -->
+*This section is for you to describe what your project does, its main features, and business purpose.*
+
+---
+
+## 🏗️ Architecture Overview
+
+This project follows the **NTC structure** with enterprise-grade patterns:
+
+- **API-First Design**: RESTful APIs with standardized JSON responses
+- **Modular Apps**: Feature-based Django applications in `apps/` directory
+- **Service/Selector Pattern**: Clean separation of business logic and data access
+- **JWT Authentication**: Secure token-based authentication with refresh tokens
+- **Background Tasks**: Celery integration for async processing
+- **Cloud Ready**: Docker containerization and deployment configurations
+
+## 📁 Project Structure
+
+```
+{project_name}/
+├── .env                    # Environment variables
+├── .knowledge/             # AI documentation for project understanding
+├── manage.py              # Django management script
+├── requirements.txt       # Python dependencies
+├── docker-compose.yml     # Local development environment
+├── {project_name}/        # Django project configuration
+│   ├── settings/          # Split settings (dev/prod)
+│   ├── urls.py           # Main URL routing
+│   └── management/       # Custom management commands
+├── apps/                 # Django applications
+│   ├── common/           # Shared utilities and base models
+│   └── [your_apps]/      # Feature-specific apps
+└── core/                 # Framework utilities and extensions
+    ├── response_wrapper.py  # Standardized API responses
+    ├── pagination.py       # DRF pagination classes
+    └── services/           # External service integrations
+```
+
+## 🚀 Quick Start
+
+### 1. Environment Setup
+```bash
+# Clone and navigate to project
+cd {project_name}
+
+# Create virtual environment
+python -m venv env
+source env/bin/activate  # On Windows: env\Scripts\activate
+
+# Install dependencies
+pip install -r requirements.txt
+```
+
+### 2. Database Setup
+```bash
+# Run migrations
+python manage.py migrate
+
+# Create superuser (optional)
+python manage.py createsuperuser
+```
+
+### 3. Run Development Server
+```bash
+python manage.py runserver
+```
+
+The API will be available at:
+- **API Base**: http://127.0.0.1:8000/
+- **Admin Panel**: http://127.0.0.1:8000/admin/
+- **API Documentation**: http://127.0.0.1:8000/docs/
+
+## 🛠️ Development Commands
+
+### App Management
+```bash
+# Create new app with NTC structure
+python manage.py create_app app_name
+
+# Alternative: Use NTC CLI (if installed globally)
+ntc create app app_name
+```
+
+### Database Operations
+```bash
+# Create migrations
+python manage.py makemigrations [app_name]
+
+# Apply migrations
+python manage.py migrate
+
+# Reset database (development only)
+python manage.py flush
+```
+
+### Development Tools
+```bash
+# Run tests
+python manage.py test
+
+# Collect static files (production)
+python manage.py collectstatic
+
+# Django shell
+python manage.py shell
+```
+
+## 🏛️ Development Patterns
+
+### API Response Format
+All endpoints return standardized responses:
+
+```json
+{
+  "status": "success|error",
+  "message": "Human-readable message",
+  "data": { /* Response data */ }
+}
+```
+
+### Service/Selector Pattern
+```python
+# Business logic in services/
+from apps.myapp.services.user_service import create_user
+
+# Data queries in selectors/
+from apps.myapp.selectors.user_selector import get_active_users
+
+# Views handle HTTP only
+@api_view(['POST'])
+def create_user_view(request):
+    user = create_user(request.data)
+    return success_response(data=user, message="User created")
+```
+
+### Model Inheritance
+```python
+# Use TimeStampedModel for automatic timestamps
+from apps.common.models import TimeStampedModel
+
+class MyModel(TimeStampedModel):
+    name = models.CharField(max_length=100)
+    # created_at and updated_at added automatically
+```
+
+## 🔧 Configuration
+
+### Environment Variables
+Copy `.env.example` to `.env` and configure:
+
+```env
+DEBUG=True
+SECRET_KEY=your-secret-key
+DATABASE_URL=sqlite:///db.sqlite3
+REDIS_URL=redis://localhost:6379
+```
+
+### Settings Structure
+- `settings/base.py` - Shared settings
+- `settings/dev.py` - Development settings
+- `settings/prod.py` - Production settings
+
+## 🐳 Docker Development
+
+### Local Development
+```bash
+# Start all services
+docker-compose up
+
+# Run in background
+docker-compose up -d
+
+# View logs
+docker-compose logs -f
+
+# Stop services
+docker-compose down
+```
+
+### Production Build
+```bash
+# Build production image
+docker build -t {project_name} .
+
+# Run production container
+docker run -p 8000:8000 {project_name}
+```
+
+## 📚 API Documentation
+
+### Interactive Documentation
+- **Swagger UI**: http://127.0.0.1:8000/docs/
+- **OpenAPI Schema**: http://127.0.0.1:8000/schema/
+
+### Authentication
+```bash
+# Get JWT tokens
+POST /auth/login/
+{
+  "email": "user@example.com",
+  "password": "password"
+}
+
+# Use access token in headers
+Authorization: Bearer <access_token>
+
+# Refresh token
+POST /auth/refresh/
+{
+  "refresh": "<refresh_token>"
+}
+```
+
+## 🧪 Testing
+
+### Run Tests
+```bash
+# All tests
+python manage.py test
+
+# Specific app
+python manage.py test apps.myapp
+
+# With coverage
+coverage run --source='.' manage.py test
+coverage report
+```
+
+### Test Structure
+```
+apps/myapp/tests/
+├── __init__.py
+├── test_models.py
+├── test_services.py
+├── test_selectors.py
+└── test_views.py
+```
+
+## 📦 Deployment
+
+### Environment Setup
+1. Set `DEBUG=False` in production
+2. Configure production database
+3. Set up Redis for caching
+4. Configure email settings
+5. Set up Celery workers
+
+### CapRover Deployment
+```bash
+# Deploy to CapRover
+caprover deploy
+
+# Or use captain-definition for auto-deployment
+git push caprover main
+```
+
+## 🔍 Troubleshooting
+
+### Common Issues
+
+**Migration Errors**:
+```bash
+# Reset migrations (development only)
+python manage.py migrate --fake-initial
+```
+
+**Import Errors**:
+- Ensure virtual environment is activated
+- Check `PYTHONPATH` includes project root
+- Verify app is in `INSTALLED_APPS`
+
+**Permission Errors**:
+- Check JWT token is valid
+- Verify user has required permissions
+- Ensure proper authentication headers
+
+## 📖 Additional Resources
+
+- **NTC Documentation**: [Link to NTC docs]
+- **Django REST Framework**: https://www.django-rest-framework.org/
+- **Django Documentation**: https://docs.djangoproject.com/
+- **Project Knowledge Base**: See `.knowledge/` directory for AI-friendly documentation
+
+## 🤝 Contributing
+
+<!-- Add your contribution guidelines here -->
+*This section is for your team's contribution guidelines, coding standards, and development workflow.*
+
+---
+
+## 📄 License
+
+<!-- Add your license information here -->
+*Add your project's license information.*
+
+---
+
+**Generated by NTC (Nexent Toolkit Console)** - A tool for creating production-ready Django REST Framework projects with best practices built-in.
+

ntc/templates/drf_structure/templates/root/django_env.txt

@@ -0,0 +1,98 @@
+# =====================================================
+# 🔧 Django Environment Configuration
+# =====================================================
+
+# Debug mode (True for development, False for production)
+DEBUG=False
+
+# Secret key used for cryptographic signing
+SECRET_KEY={secret_key}
+
+BASE_URL=http://127.0.0.1:8000
+BACKEND_URL=http://127.0.0.1:8000
+FRONTEND_URL=http://127.0.0.1:3000
+
+# =====================================================
+# 🗄️ Database Configuration
+# =====================================================
+# By default, SQLite is used. Uncomment and configure 
+# the variables below to use PostgreSQL or another DB.
+# =====================================================
+
+# Example:
+DATABASE_ENGINE=django.db.backends.postgresql
+DATABASE_NAME=mydb
+DATABASE_USER=myuser
+DATABASE_PASSWORD=mypass
+DATABASE_HOST=localhost
+DATABASE_PORT=5432
+#
+# For SQLite (default):
+DATABASE_ENGINE=django.db.backends.sqlite3
+DATABASE_NAME=db.sqlite3
+
+# =====================================================
+# 📧 Email Configuration
+# =====================================================
+EMAIL_HOST=
+EMAIL_HOST_USER=
+EMAIL_HOST_PASSWORD=
+EMAIL_PORT=
+DEFAULT_FROM_EMAIL=
+
+# =====================================================
+# ☁️ Azure Communication Services (Email)
+# =====================================================
+# Production sends go through ACS when endpoint + access_key are configured.
+# In dev/tests, leave them blank to fall back to console.EmailBackend.
+AZURE_COMMUNICATION_ENDPOINT=
+AZURE_COMMUNICATION_ACCESS_KEY=
+AZURE_COMMUNICATION_EMAIL_SENDER_NO_REPLY=
+AZURE_COMMUNICATION_EMAIL_SENDER_NOTIFICATION=
+AZURE_COMMUNICATION_EMAIL_SENDER_SUPPORT=
+AZURE_COMMUNICATION_EMAIL_SENDER_MARKETING=
+AZURE_COMMUNICATION_EMAIL_SENDER=
+AZURE_COMMUNICATION_EMAIL_DEFAULT_SENDER_KEY=notification
+AZURE_COMMUNICATION_EMAIL_POLLING_INTERVAL_SECONDS=2
+AZURE_COMMUNICATION_EMAIL_TIMEOUT_SECONDS=60
+
+# =====================================================
+# 🔐 JWT Authentication Settings
+# =====================================================
+# Token lifetime in minutes
+JWT_ACCESS_TTL_MINUTES=15
+
+# =====================================================
+# 🔁 Redis Configuration
+# =====================================================
+REDIS_HOST=
+REDIS_USER=
+REDIS_PASSWORD=
+REDIS_PORT=
+
+# =====================================================
+# 🛡️ Sentry Configuration
+# =====================================================
+# Sentry DSN for error tracking and performance monitoring
+SENTRY_DSN=
+
+# =====================================================
+# ☁️ Cloudflare R2 (S3-compatible Storage)
+# =====================================================
+R2_ACCOUNT_ID=
+R2_ACCESS_KEY_ID=
+R2_SECRET_ACCESS_KEY=
+R2_BUCKET=
+R2_REGION=auto
+R2_ENDPOINT=
+R2_PUBLIC_BASE_URL=
+R2_MEDIA_PATH=
+
+# =====================================================
+# ☁️ External Service Credentials
+# =====================================================
+# Azure Email Services
+BEEM_API_KEY=
+SELCOM_MERCHANT_ID=
+CLICKPESA_CLIENT_ID=
+POLAR_API_KEY=

ntc/templates/drf_structure/templates/root/django_requirements.txt

@@ -0,0 +1,24 @@
+Django
+django-cors-headers
+djangorestframework
+djangorestframework-jwt
+djangorestframework-simplejwt
+gunicorn
+PyJWT
+pytz
+channels
+django-environ
+django-background-tasks
+celery
+django-celery-results
+django-celery-beat
+azure-common
+azure-communication-email
+azure-core
+azure-identity
+azure-mgmt-communication
+pillow
+colorama
+sentry-sdk
+boto3
+botocore

ntc/templates/drf_structure/templates/root/gitignore.txt

@@ -0,0 +1,6 @@
+venv/
+__pycache__/
+*.pyc
+*.pyo
+*.db
+.env

ntc/templates/drf_structure/templates/root/manage.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == '__main__':
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', '{project_name}.settings.dev')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError('Django not found, install it first!') from exc
+    execute_from_command_line(sys.argv)

ntc/templates/flutter/.gitignore

@@ -0,0 +1,44 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+migrate_working_dir/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+/build/
+
+# Symbolication related
+app.*.symbols
+
+# Obfuscation related
+app.*.map.json
+
+# Android Studio will place build artifacts here
+/android/app/debug
+/android/app/profile
+/android/app/release