Metadata-Version: 2.4
Name: ntc-dev-kit
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
Author-email: Nexent <dev@nexent.com>
License: MIT
Project-URL: Homepage, https://github.com/nexent/ntc
Project-URL: Repository, https://github.com/nexent/ntc
Project-URL: Issues, https://github.com/nexent/ntc/issues
Keywords: cli,scaffold,django,drf,react,nextjs,flutter,generator,boilerplate
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: colorama>=0.4.6
Requires-Dist: pyyaml>=6.0
Requires-Dist: textual>=0.47.0
Provides-Extra: dev
Requires-Dist: build>=1.0; extra == "dev"
Requires-Dist: twine>=4.0; extra == "dev"
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: black>=23.0; extra == "dev"
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# NTC - Nexent Toolkit Console

A powerful CLI scaffolding tool for rapidly bootstrapping modern web and mobile projects.

## Overview

NTC (Nexent Toolkit Console) is a command-line interface that generates production-ready project boilerplates for:

- **Backend**: Django REST Framework with authentication, Celery, Docker support
- **Frontend**: React, React Admin, Next.js
- **Mobile**: Flutter

## Features

- **Interactive project initialization** with step-by-step prompts
- **Django REST Framework scaffolding** with JWT authentication, custom User models, and API documentation
- **Environment setup automation** (virtual environments, dependency installation)
- **Docker & Docker Compose** configuration included
- **Authentication app generator** with login, register, password reset endpoints
- **Modular app architecture** with pre-configured common utilities

## Installation

```bash
pip install ntc-dev-kit
```

## Quick Start

Create a new project interactively:

```bash
ntc init
```

Or specify technology directly:

```bash
# Django REST API backend
ntc init --technology django

# React frontend
ntc init --technology react

# Next.js full-stack
ntc init --technology nextjs

# Flutter mobile
ntc init --technology flutter
```

## Usage

### Interactive Mode

```bash
ntc init
```

Navigate menus with **arrow keys**, select with **Enter**, exit with **Escape**.

### Technology Options

| Technology | Description |
|-----------|-------------|
| `django` | Django REST Framework with JWT auth, Celery, Docker |
| `react` | React Vite project with TypeScript |
| `react-admin` | React Admin dashboard template |
| `nextjs` | Next.js full-stack application |
| `flutter` | Flutter mobile application |

### Additional Commands

```bash
# Create a new Django app within your project
ntc create app <app_name>

# Show help
ntc --help
```

## Django Project Structure

When you create a Django project, you get:

```
myproject/
├── .env                          # Environment variables
├── .gitignore
├── requirements.txt
├── manage.py
├── Dockerfile
├── docker-compose.yml
├── config/                       # Gunicorn & nginx config
├── .entry/                       # Startup scripts
├── .knowledge/                   # AI documentation
├── apps/
│   ├── __init__.py
│   ├── common/                   # Common utilities
│   └── authentication/           # (Optional) Auth app
├── core/                         # Core utilities
│   ├── pagination.py
│   ├── base_model.py
│   ├── response_wrapper.py
│   └── services/                 # Azure/AWS services
└── myproject/                    # Django project settings
    ├── settings/
    ├── urls.py
    ├── asgi.py
    ├── wsgi.py
    └── commands/                 # Management commands
```

## Requirements

- **Python**: >= 3.10
- **Operating System**: Windows, macOS, Linux

## Dependencies

- `colorama` - Cross-platform colored terminal output
- `pyyaml` - YAML configuration parsing

## Development

```bash
# Clone repository
git clone https://github.com/nexent/ntc.git
cd ntc

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

# Code formatting
black ntc/
ruff check ntc/
```

## License

MIT License - see [LICENSE](LICENSE) for details.

## Support

- **Issues**: [GitHub Issues](https://github.com/nexent/ntc/issues)
- **Repository**: [GitHub](https://github.com/nexent/ntc)
