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

{ntc_dev_kit-1.0.6 → ntc_dev_kit-1.2.0}/MANIFEST.in

@@ -3,6 +3,7 @@ include LICENSE
 include requirements.txt
 recursive-include ntc/templates *.py *.json *.md *.txt *.html *.ts *.tsx *.css *.scss *.yml *.yaml *.sh *.conf *.cfg
 recursive-include ntc/templates *.env.example *.gitignore
+recursive-include ntc/templates *.js *.mjs *.dart Dockerfile captain-definition
 
 global-exclude __pycache__
 global-exclude *.py[co]

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ntc-dev-kit
-Version: 1.0.6
+Version: 1.2.0
 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
@@ -97,7 +97,31 @@ ntc init --technology flutter
 ntc init
 ```
 
-Navigate menus with **arrow keys**, select with **Enter**, exit with **Escape**.
+A few questions, asked inline: project name, what you're building, where it goes, then the
+options for that technology (sign-in and Python environment for Django; installing dependencies
+for the others), a summary, and **Create?**. The defaults are already selected, so Enter takes
+them; **↑/↓** move, a **number key** picks an option at once, **Esc** cancels without writing
+anything. Each answer collapses to one line, and the only progress shown is for real work
+(creating the environment, installing packages).
+
+### Without questions
+
+Every answer can be given as a flag; with `--yes` nothing is asked (scripts, CI, AI agents):
+
+```bash
+ntc init -t django --name shop-api --with-auth --env venv --yes
+ntc init -t nextjs --name site --install --yes
+```
+
+| Flag | Meaning |
+|------|---------|
+| `-t`, `--technology` | `django`, `nextjs`, `react-admin`, `react`, `flutter` |
+| `--name` | Project name (`.` = the current folder) |
+| `--path` | Folder to create the project in (default: current folder) |
+| `--with-auth` / `--no-auth` | Django: include the sign-in app (custom User model, JWT, migration included) |
+| `--env` | Django: `venv`, `conda`, `existing` (the active virtualenv) or `skip` |
+| `--install` / `--no-install` | Others: run `npm install` / `flutter pub get` |
+| `--yes`, `-y` | Ask nothing; needs `--name` and `--technology` |
 
 ### Technology Options
 

{ntc_dev_kit-1.0.6 → ntc_dev_kit-1.2.0}/README.md

@@ -57,7 +57,31 @@ ntc init --technology flutter
 ntc init
 ```
 
-Navigate menus with **arrow keys**, select with **Enter**, exit with **Escape**.
+A few questions, asked inline: project name, what you're building, where it goes, then the
+options for that technology (sign-in and Python environment for Django; installing dependencies
+for the others), a summary, and **Create?**. The defaults are already selected, so Enter takes
+them; **↑/↓** move, a **number key** picks an option at once, **Esc** cancels without writing
+anything. Each answer collapses to one line, and the only progress shown is for real work
+(creating the environment, installing packages).
+
+### Without questions
+
+Every answer can be given as a flag; with `--yes` nothing is asked (scripts, CI, AI agents):
+
+```bash
+ntc init -t django --name shop-api --with-auth --env venv --yes
+ntc init -t nextjs --name site --install --yes
+```
+
+| Flag | Meaning |
+|------|---------|
+| `-t`, `--technology` | `django`, `nextjs`, `react-admin`, `react`, `flutter` |
+| `--name` | Project name (`.` = the current folder) |
+| `--path` | Folder to create the project in (default: current folder) |
+| `--with-auth` / `--no-auth` | Django: include the sign-in app (custom User model, JWT, migration included) |
+| `--env` | Django: `venv`, `conda`, `existing` (the active virtualenv) or `skip` |
+| `--install` / `--no-install` | Others: run `npm install` / `flutter pub get` |
+| `--yes`, `-y` | Ask nothing; needs `--name` and `--technology` |
 
 ### Technology Options
 

{ntc_dev_kit-1.0.6 → ntc_dev_kit-1.2.0}/ntc/__init__.py

@@ -1,5 +1,5 @@
-"""NTC - Nexent Toolkit Console."""
-
-__version__ = "1.0.0"
-__author__ = "Nexent"
-__license__ = "MIT"
+"""NTC - Nexent Toolkit Console."""
+
+__version__ = "1.2.0"
+__author__ = "Nexent"
+__license__ = "MIT"

{ntc_dev_kit-1.0.6 → ntc_dev_kit-1.2.0}/ntc/app_creator.py

@@ -72,40 +72,45 @@ def hello_world(request):
     }
     return fallbacks.get(template_name, '')
 
-def create_app_structure(app_name):
-    """Create the NTC app directory structure."""
+def create_app_structure(app_name, add_urls=True, url_prefix=None):
+    """Create the NTC app directory structure.
+
+    add_urls: include the app's URLs - in the project's api_v1 list (/api/v1/<app>/) by default,
+    or, with url_prefix, in the root urlpatterns under that prefix. False leaves it to you.
+    """
     # Sanitize app name using the same function as project names
     original_name = app_name
     app_name = sanitize_project_name(app_name)
-    
+
     if app_name != original_name:
         print_info(f"App name sanitized: '{original_name}' -> '{app_name}'")
-    
+
     # Check if we're in a Django project root
     if not os.path.exists('manage.py'):
         print_error("Not in a Django project root directory. Please run this command from your project root.")
         return False
-    
+
     # Check if apps directory exists
     if not os.path.exists('apps'):
         print_info("Creating apps directory...")
         os.makedirs('apps', exist_ok=True)
         # Create apps/__init__.py
-        with open('apps/__init__.py', 'w') as f:
+        with open('apps/__init__.py', 'w', encoding='utf-8') as f:
             f.write('')
-    
+
     base_path = os.path.join('apps', app_name)
-    
+
     # Check if app already exists
     if os.path.exists(base_path):
         print_error(f"App '{app_name}' already exists in apps/{app_name}/")
         return False
-    
+
     print_info(f"Creating app structure for '{app_name}'...")
-    
+
     # Create directories
     directories = [
         base_path,
+        os.path.join(base_path, 'migrations'),
         os.path.join(base_path, 'permissions'),
         os.path.join(base_path, 'serializers'),
         os.path.join(base_path, 'selectors'),
@@ -114,14 +119,14 @@ def create_app_structure(app_name):
         os.path.join(base_path, 'tasks'),
         os.path.join(base_path, 'tests'),
     ]
-    
+
     for directory in directories:
         os.makedirs(directory, exist_ok=True)
         # Create __init__.py in each directory
         init_file = os.path.join(directory, '__init__.py')
-        with open(init_file, 'w') as f:
+        with open(init_file, 'w', encoding='utf-8') as f:
             f.write('')
-    
+
     # Create main app files
     files_content = {
         'admin.py': get_app_template_content('app_admin.py', app_name),
@@ -130,167 +135,153 @@ def create_app_structure(app_name):
         'urls.py': get_app_template_content('app_urls.py', app_name),
         'views.py': get_app_template_content('app_views.py', app_name),
     }
-    
+
     for filename, content in files_content.items():
         file_path = os.path.join(base_path, filename)
-        with open(file_path, 'w') as f:
+        with open(file_path, 'w', encoding='utf-8') as f:
             f.write(content)
-    
+
     print_success(f"App '{app_name}' created successfully!")
-    
+
     # Add to INSTALLED_APPS
     if add_to_installed_apps(app_name):
         print_success(f"Added 'apps.{app_name}' to INSTALLED_APPS")
     else:
         print_info(f"Please manually add 'apps.{app_name}' to INSTALLED_APPS in your settings")
-    
+
     # Add to main URLs
-    if add_to_main_urls(app_name):
-        print_success(f"Added app URLs to main urls.py")
+    url_line = f"path('{(url_prefix or '').strip('/') + '/' if url_prefix else ''}{app_name}/', include('apps.{app_name}.urls'))"
+    if not add_urls:
+        print_info(f"URLs not added (--no-url). Include them where you want, e.g.: {url_line}")
     else:
-        print_info(f"Please manually add: path('{app_name}/', include('apps.{app_name}.urls')) to your main urls.py")
-    
+        where = add_to_main_urls(app_name, url_prefix)
+        if where:
+            print_success(f"Added the app's URLs to {where}")
+        else:
+            print_info(f"Please add the app's URLs to your urls.py, e.g.: {url_line}")
+
     print_info("Next steps:")
-    print_info(f"  1. Test the app: GET /{app_name}/hello/ (returns Hello World)")
-    print_info(f"  2. Run 'python manage.py makemigrations {app_name}' after creating models")
-    print_info(f"  3. Start building your API endpoints in apps/{app_name}/views.py")
-    
+    print_info(f"  1. Add models to apps/{app_name}/models.py, then: python manage.py makemigrations {app_name}")
+    print_info(f"  2. Add views to apps/{app_name}/views.py and list them in apps/{app_name}/urls.py")
+
     return True
 
+
+def _project_package():
+    """The Django project package, from manage.py's DJANGO_SETTINGS_MODULE ('shop.settings.dev'
+    -> 'shop'). None if manage.py doesn't say."""
+    try:
+        with open('manage.py', 'r', encoding='utf-8') as f:
+            manage = f.read()
+    except OSError:
+        return None
+    match = re.search(r"DJANGO_SETTINGS_MODULE['\"]\s*,\s*['\"]([\w.]+)['\"]", manage)
+    if not match:
+        return None
+    package = match.group(1).split('.')[0]
+    return package if os.path.isdir(package) else None
+
+
+def _settings_file():
+    """The settings module that declares INSTALLED_APPS: <project>/settings/base.py in an NTC
+    project, else <project>/settings.py. (This used to walk the tree and stop after the first
+    folder, so it never found either and INSTALLED_APPS was never updated.)"""
+    package = _project_package()
+    if not package:
+        return None
+    for candidate in (os.path.join(package, 'settings', 'base.py'), os.path.join(package, 'settings.py')):
+        if os.path.exists(candidate):
+            return candidate
+    return None
+
+
 def add_to_installed_apps(app_name):
     """Add the new app to INSTALLED_APPS in settings."""
-    # Find settings files
-    settings_files = []
-    
-    # Look for settings in common locations
-    possible_settings = [
-        'settings.py',
-        'settings/base.py',
-        'settings/dev.py',
-    ]
-    
-    # Find project directory (should contain settings)
-    for root, dirs, files in os.walk('.'):
-        if 'settings.py' in files or 'settings' in dirs:
-            for settings_file in possible_settings:
-                settings_path = os.path.join(root, settings_file)
-                if os.path.exists(settings_path):
-                    settings_files.append(settings_path)
-            break
-    
-    if not settings_files:
+    settings_file = _settings_file()
+    if not settings_file:
         return False
-    
-    # Use the first settings file found (usually base.py or settings.py)
-    settings_file = settings_files[0]
-    
+
     try:
         with open(settings_file, 'r', encoding='utf-8') as f:
             content = f.read()
-        
+
         # Check if app is already in INSTALLED_APPS
         if f"'apps.{app_name}'" in content or f'"apps.{app_name}"' in content:
             return True  # Already added
-        
-        # Find INSTALLED_APPS and add the new app
-        import re
-        
+
         # Pattern to match INSTALLED_APPS
         pattern = r'(INSTALLED_APPS\s*=\s*\[)(.*?)(\])'
         match = re.search(pattern, content, re.DOTALL)
-        
+
         if match:
             start, apps_content, end = match.groups()
-            
+
             # Add the new app to the end of the list
             new_app_line = f"    'apps.{app_name}',\n"
-            
+
             # Insert before the closing bracket
             new_content = content.replace(
                 match.group(0),
                 f"{start}{apps_content.rstrip()}\n{new_app_line}{end}"
             )
-            
+
             with open(settings_file, 'w', encoding='utf-8') as f:
                 f.write(new_content)
-            
+
             return True
-        
+
     except Exception as e:
         print_error(f"Failed to update INSTALLED_APPS: {e}")
         return False
-    
+
     return False
 
-def add_to_main_urls(app_name):
-    """Add the new app URLs to the main urls.py file."""
-    # Find main urls.py
-    urls_files = []
-    
-    # Look for main urls.py (usually in project root or project directory)
-    for root, dirs, files in os.walk('.'):
-        if 'urls.py' in files:
-            urls_path = os.path.join(root, 'urls.py')
-            # Skip app-specific urls.py files
-            if 'apps' not in root:
-                urls_files.append(urls_path)
-    
-    if not urls_files:
-        return False
-    
-    # Use the first main urls.py found
-    urls_file = urls_files[0]
-    
+def add_to_main_urls(app_name, url_prefix=None):
+    """Include the app's URLs in the project's urls.py. Returns a description of where, or None.
+
+    Without url_prefix: into the `api_v1 = [...]` list NTC projects version their API with
+    (/api/v1/<app>/). With url_prefix: into the root `urlpatterns` under that prefix. Only the
+    project's own urls.py is edited (found through manage.py) - the old tree walk could pick up
+    a urls.py inside the virtualenv.
+    """
+    package = _project_package()
+    urls_file = os.path.join(package, 'urls.py') if package else None
+    if not urls_file or not os.path.exists(urls_file):
+        return None
+
     try:
         with open(urls_file, 'r', encoding='utf-8') as f:
             content = f.read()
-        
-        # Check if app URLs are already included
-        if f"'{app_name}/'" in content or f'"{app_name}/"' in content:
-            return True  # Already added
-        
-        # Check if include is imported
-        if 'from django.urls import' in content:
-            if 'include' not in content:
-                # Add include to existing import
-                content = content.replace(
-                    'from django.urls import',
-                    'from django.urls import include,'
-                ).replace('include,', 'include, ')
+
+        if f"include('apps.{app_name}.urls')" in content:
+            return urls_file  # Already added
+
+        if url_prefix is None:
+            list_name, route = 'api_v1', f'{app_name}/'
+            if not re.search(r'api_v1\s*=\s*\[', content):
+                return None  # not an NTC project layout: say what to add rather than guess
         else:
-            # Add the import at the top
-            lines = content.split('\n')
-            for i, line in enumerate(lines):
-                if line.startswith('from django.'):
-                    lines.insert(i + 1, 'from django.urls import path, include')
-                    break
-            content = '\n'.join(lines)
-        
-        # Find urlpatterns and add the new app
-        import re
-        
-        pattern = r'(urlpatterns\s*=\s*\[)(.*?)(\])'
+            list_name, route = 'urlpatterns', f"{url_prefix.strip('/')}/{app_name}/" if url_prefix.strip('/') else f'{app_name}/'
+
+        # Make sure include is imported
+        if not re.search(r'from django\.urls import [^\n]*\binclude\b', content):
+            if 'from django.urls import' in content:
+                content = content.replace('from django.urls import ', 'from django.urls import include, ', 1)
+            else:
+                content = 'from django.urls import include, path\n' + content
+
+        pattern = rf'({list_name}\s*=\s*\[)(.*?)(\n\])'
         match = re.search(pattern, content, re.DOTALL)
-        
-        if match:
-            start, urls_content, end = match.groups()
-            
-            # Add the new app URL pattern
-            new_url_line = f"    path('{app_name}/', include('apps.{app_name}.urls')),\n"
-            
-            # Insert before the closing bracket
-            new_content = content.replace(
-                match.group(0),
-                f"{start}{urls_content.rstrip()}\n{new_url_line}{end}"
-            )
-            
-            with open(urls_file, 'w', encoding='utf-8') as f:
-                f.write(new_content)
-            
-            return True
-        
+        if not match:
+            return None
+        start, urls_content, end = match.groups()
+        new_url_line = f"\n    path('{route}', include('apps.{app_name}.urls')),"
+        content = content.replace(match.group(0), f"{start}{urls_content.rstrip()}{new_url_line}{end}", 1)
+
+        with open(urls_file, 'w', encoding='utf-8') as f:
+            f.write(content)
+        return f"{urls_file} ({list_name}: /{'api/v1/' if list_name == 'api_v1' else ''}{route})"
+
     except Exception as e:
         print_error(f"Failed to update main urls.py: {e}")
-        return False
-    
-    return False
+        return None