# NextPy CLI
<div align="center">
<img src="https://raw.githubusercontent.com/VesperAkshay/nextpy/main/logo.png" alt="NextPy Logo" width="150" style="border-radius: 20px;" />
> Scaffold full-stack FastAPI + Next.js applications in seconds
[](https://pypi.org/project/nextpy-cli/)
[](https://pypi.org/project/nextpy-cli/)
[](https://opensource.org/licenses/MIT)
</div>
NextPy is a powerful CLI tool that helps you quickly scaffold modern full-stack applications with FastAPI backend and Next.js frontend, complete with Docker support and multiple database options.
## 🚀 Quick Start
### Recommended: Using uvx (Fastest)
No installation required! Run directly:
```bash
uvx nextpy-cli my-awesome-app
```
### Alternative Methods
```bash
# Using pip
pip install nextpy-cli
nextpy my-awesome-app
# Using uv (faster pip)
uv pip install nextpy-cli
nextpy my-awesome-app
# Using pipx (isolated environment)
pipx install nextpy-cli
nextpy my-awesome-app
```
## ✨ Features
- **🦊 Fox - Your Smart Dev Companion** - Intelligent CLI mascot that remembers your preferences and provides contextual suggestions
- **FastAPI Backend** - Modern, fast Python web framework
- **Next.js Frontend** - React framework with TypeScript support
- **Multiple Database Options** - PostgreSQL, MongoDB, or SQLite
- **Docker Ready** - Complete Docker and Docker Compose setup
- **TypeScript** - Full TypeScript support for type safety
- **Vite** - Lightning-fast development with Vite
- **Interactive CLI** - Beautiful, user-friendly prompts powered by Rich and Questionary
- **Smart Suggestions** - Fox learns your preferences and suggests your usual stack
- **Best Practices** - Production-ready project structure
## 📦 What You Get
### Backend (FastAPI)
- RESTful API structure
- Database integration (PostgreSQL/MongoDB/SQLite)
- Environment configuration
- CORS setup
- Health check endpoints
- Docker configuration
### Frontend (Next.js)
- TypeScript configuration
- Vite for fast development
- API client setup
- Modern React patterns
- Responsive design ready
- Docker configuration
### DevOps
- Docker Compose for local development
- Separate Dockerfiles for frontend and backend
- Environment variable management
- Production-ready configurations
## 🎯 Usage
### Create a New Project
```bash
# Quick start with uvx (recommended)
uvx nextpy-cli my-project
# Or if installed
nextpy my-project
```
The CLI will guide you through:
1. Project name
2. Frontend framework (Next.js or Vite + React)
3. Database choice (SQLite, PostgreSQL, or MongoDB)
4. Docker support (yes/no)
5. GitHub repository initialization (yes/no)
6. Automatic setup and installation
### Start Development
```bash
cd my-project
# Start with Docker Compose (recommended)
docker-compose up
# Or start services individually:
# Backend
cd backend
pip install -r requirements.txt
uvicorn main:app --reload
# Frontend
cd frontend
npm install
npm run dev
```
## 🌐 Access Your Application
- **Frontend**: http://localhost:3000
- **Backend API**: http://localhost:8000
- **API Docs**: http://localhost:8000/docs
## 🦊 Meet Fox - Your Smart Dev Companion
Fox is NextPy's intelligent CLI mascot that makes project creation delightful and efficient!
### What Fox Does:
- **Remembers Your Preferences** - "You usually go with Next.js + PostgreSQL. Use that again?"
- **Smart Suggestions** - Recommends the right database for your project type
- **Celebrates Milestones** - Special messages for your 1st, 5th, 10th, 25th, and 50th projects!
- **Contextual Tips** - Provides relevant advice based on your choices
- **Personality Modes** - Choose how chatty Fox should be
### Fox Modes:
```bash
# Verbose - Maximum personality, tips, and commentary
nextpy my-project --fox-mode verbose
# Normal - Balanced helpfulness (default)
nextpy my-project --fox-mode normal
# Quiet - Essential messages only
nextpy my-project --fox-mode quiet
# Silent - No Fox messages
nextpy my-project --fox-mode silent
# Set globally with environment variable
export NEXTPY_FOX_MODE=verbose
nextpy my-project
```
### Quick Commands:
```bash
# Use your last configuration
nextpy my-new-project --last
# Combine options
nextpy my-project --fox-mode verbose --last
```
### Fox Features:
- 🧠 **Smart Memory** - Tracks your preferences across projects (stored in `~/.nextpy/preferences.json`)
- 💡 **Context-Aware** - Detects project types (e-commerce, blog, API, etc.)
- 🎯 **Intelligent Recommendations** - Suggests appropriate tech stacks
- 🎉 **Milestone Celebrations** - Acknowledges your progress
- 🎨 **Personality** - Witty, dev-focused messages
## 📋 Requirements
- **Python** 3.11 or higher
- **Node.js** 18+ (for the generated frontend)
- **Docker** (optional, but recommended)
## 🛠️ Project Structure
```
my-project/
├── backend/
│ ├── main.py # FastAPI application
│ ├── requirements.txt # Python dependencies
│ ├── .env # Environment variables
│ └── Dockerfile
├── frontend/
│ ├── src/
│ │ ├── pages/ # Next.js pages
│ │ ├── components/ # React components
│ │ └── lib/ # Utilities
│ ├── package.json
│ └── Dockerfile
├── docker-compose.yml # Docker orchestration
└── README.md # Project documentation
```
## 🔧 Installation
### Using uvx (Recommended - No Installation)
Run directly without installing:
```bash
uvx nextpy-cli my-project
```
**Advantages:**
- ⚡ 10-100x faster than pip
- ✅ No installation needed
- ✅ Isolated environment
- ✅ Always latest version
### From PyPI
```bash
# Using pip
pip install nextpy-cli
# Using uv (faster)
uv pip install nextpy-cli
# Using pipx (isolated)
pipx install nextpy-cli
```
### From Source
```bash
git clone https://github.com/VesperAkshay/nextpy.git
cd nextpy/python-cli
pip install -e .
```
### Installing uv/uvx
If you don't have `uv` installed:
```bash
# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh
# Windows
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
# Or with pip
pip install uv
```
## 🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## 📄 License
MIT License - see the [LICENSE](https://github.com/VesperAkshay/nextpy/blob/main/LICENSE) file for details.
## 🔗 Links
- [GitHub Repository](https://github.com/VesperAkshay/nextpy)
- [Report Issues](https://github.com/VesperAkshay/nextpy/issues)
- [PyPI Package](https://pypi.org/project/nextpy-cli/)
- [npm Package](https://www.npmjs.com/package/nextpy)
## 💡 Why NextPy?
- **Save Time**: Skip the boilerplate and start building features immediately
- **Best Practices**: Pre-configured with industry standards
- **Flexible**: Choose your database and customize as needed
- **Modern Stack**: Use the latest and greatest technologies
- **Docker Ready**: Deploy anywhere with confidence
- **Python-First**: Built by Python developers, for Python developers
## 🐛 Troubleshooting
### Command not found after installation
Make sure your Python scripts directory is in your PATH:
```bash
# On Linux/Mac
export PATH="$HOME/.local/bin:$PATH"
# On Windows
# Add %APPDATA%\Python\Python311\Scripts to your PATH
```
### Permission errors on Linux/Mac
```bash
pip install --user nextpy-cli
```
## 📚 Documentation
For more detailed documentation, visit our [GitHub repository](https://github.com/VesperAkshay/nextpy).
---
Made with ❤️ by [VesperAkshay](https://github.com/VesperAkshay)
Raw data
{
"_id": null,
"home_page": null,
"name": "nextpy-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "cli, fastapi, nextjs, vite, react, fullstack, scaffold, boilerplate, generator, python, typescript, docker, postgresql, mongodb, sqlite, ai, fox, intelligent, presets, preferences",
"author": null,
"author_email": "VesperAkshay <vesperakshay@example.com>",
"download_url": "https://files.pythonhosted.org/packages/7a/fc/9ae679002f6aa8123df1d93595931607f590cae25bb4f1ca7124d6f7c812/nextpy_cli-1.1.0.tar.gz",
"platform": null,
"description": "# NextPy CLI\n\n<div align=\"center\">\n\n<img src=\"https://raw.githubusercontent.com/VesperAkshay/nextpy/main/logo.png\" alt=\"NextPy Logo\" width=\"150\" style=\"border-radius: 20px;\" />\n\n> Scaffold full-stack FastAPI + Next.js applications in seconds\n\n[](https://pypi.org/project/nextpy-cli/)\n[](https://pypi.org/project/nextpy-cli/)\n[](https://opensource.org/licenses/MIT)\n\n</div>\n\nNextPy is a powerful CLI tool that helps you quickly scaffold modern full-stack applications with FastAPI backend and Next.js frontend, complete with Docker support and multiple database options.\n\n## \ud83d\ude80 Quick Start\n\n### Recommended: Using uvx (Fastest)\n\nNo installation required! Run directly:\n\n```bash\nuvx nextpy-cli my-awesome-app\n```\n\n### Alternative Methods\n\n```bash\n# Using pip\npip install nextpy-cli\nnextpy my-awesome-app\n\n# Using uv (faster pip)\nuv pip install nextpy-cli\nnextpy my-awesome-app\n\n# Using pipx (isolated environment)\npipx install nextpy-cli\nnextpy my-awesome-app\n```\n\n## \u2728 Features\n\n- **\ud83e\udd8a Fox - Your Smart Dev Companion** - Intelligent CLI mascot that remembers your preferences and provides contextual suggestions\n- **FastAPI Backend** - Modern, fast Python web framework\n- **Next.js Frontend** - React framework with TypeScript support\n- **Multiple Database Options** - PostgreSQL, MongoDB, or SQLite\n- **Docker Ready** - Complete Docker and Docker Compose setup\n- **TypeScript** - Full TypeScript support for type safety\n- **Vite** - Lightning-fast development with Vite\n- **Interactive CLI** - Beautiful, user-friendly prompts powered by Rich and Questionary\n- **Smart Suggestions** - Fox learns your preferences and suggests your usual stack\n- **Best Practices** - Production-ready project structure\n\n## \ud83d\udce6 What You Get\n\n### Backend (FastAPI)\n- RESTful API structure\n- Database integration (PostgreSQL/MongoDB/SQLite)\n- Environment configuration\n- CORS setup\n- Health check endpoints\n- Docker configuration\n\n### Frontend (Next.js)\n- TypeScript configuration\n- Vite for fast development\n- API client setup\n- Modern React patterns\n- Responsive design ready\n- Docker configuration\n\n### DevOps\n- Docker Compose for local development\n- Separate Dockerfiles for frontend and backend\n- Environment variable management\n- Production-ready configurations\n\n## \ud83c\udfaf Usage\n\n### Create a New Project\n\n```bash\n# Quick start with uvx (recommended)\nuvx nextpy-cli my-project\n\n# Or if installed\nnextpy my-project\n```\n\nThe CLI will guide you through:\n1. Project name\n2. Frontend framework (Next.js or Vite + React)\n3. Database choice (SQLite, PostgreSQL, or MongoDB)\n4. Docker support (yes/no)\n5. GitHub repository initialization (yes/no)\n6. Automatic setup and installation\n\n### Start Development\n\n```bash\ncd my-project\n\n# Start with Docker Compose (recommended)\ndocker-compose up\n\n# Or start services individually:\n\n# Backend\ncd backend\npip install -r requirements.txt\nuvicorn main:app --reload\n\n# Frontend\ncd frontend\nnpm install\nnpm run dev\n```\n\n## \ud83c\udf10 Access Your Application\n\n- **Frontend**: http://localhost:3000\n- **Backend API**: http://localhost:8000\n- **API Docs**: http://localhost:8000/docs\n\n## \ud83e\udd8a Meet Fox - Your Smart Dev Companion\n\nFox is NextPy's intelligent CLI mascot that makes project creation delightful and efficient!\n\n### What Fox Does:\n\n- **Remembers Your Preferences** - \"You usually go with Next.js + PostgreSQL. Use that again?\"\n- **Smart Suggestions** - Recommends the right database for your project type\n- **Celebrates Milestones** - Special messages for your 1st, 5th, 10th, 25th, and 50th projects!\n- **Contextual Tips** - Provides relevant advice based on your choices\n- **Personality Modes** - Choose how chatty Fox should be\n\n### Fox Modes:\n\n```bash\n# Verbose - Maximum personality, tips, and commentary\nnextpy my-project --fox-mode verbose\n\n# Normal - Balanced helpfulness (default)\nnextpy my-project --fox-mode normal\n\n# Quiet - Essential messages only\nnextpy my-project --fox-mode quiet\n\n# Silent - No Fox messages\nnextpy my-project --fox-mode silent\n\n# Set globally with environment variable\nexport NEXTPY_FOX_MODE=verbose\nnextpy my-project\n```\n\n### Quick Commands:\n\n```bash\n# Use your last configuration\nnextpy my-new-project --last\n\n# Combine options\nnextpy my-project --fox-mode verbose --last\n```\n\n### Fox Features:\n\n- \ud83e\udde0 **Smart Memory** - Tracks your preferences across projects (stored in `~/.nextpy/preferences.json`)\n- \ud83d\udca1 **Context-Aware** - Detects project types (e-commerce, blog, API, etc.)\n- \ud83c\udfaf **Intelligent Recommendations** - Suggests appropriate tech stacks\n- \ud83c\udf89 **Milestone Celebrations** - Acknowledges your progress\n- \ud83c\udfa8 **Personality** - Witty, dev-focused messages\n\n## \ud83d\udccb Requirements\n\n- **Python** 3.11 or higher\n- **Node.js** 18+ (for the generated frontend)\n- **Docker** (optional, but recommended)\n\n## \ud83d\udee0\ufe0f Project Structure\n\n```\nmy-project/\n\u251c\u2500\u2500 backend/\n\u2502 \u251c\u2500\u2500 main.py # FastAPI application\n\u2502 \u251c\u2500\u2500 requirements.txt # Python dependencies\n\u2502 \u251c\u2500\u2500 .env # Environment variables\n\u2502 \u2514\u2500\u2500 Dockerfile\n\u251c\u2500\u2500 frontend/\n\u2502 \u251c\u2500\u2500 src/\n\u2502 \u2502 \u251c\u2500\u2500 pages/ # Next.js pages\n\u2502 \u2502 \u251c\u2500\u2500 components/ # React components\n\u2502 \u2502 \u2514\u2500\u2500 lib/ # Utilities\n\u2502 \u251c\u2500\u2500 package.json\n\u2502 \u2514\u2500\u2500 Dockerfile\n\u251c\u2500\u2500 docker-compose.yml # Docker orchestration\n\u2514\u2500\u2500 README.md # Project documentation\n```\n\n## \ud83d\udd27 Installation\n\n### Using uvx (Recommended - No Installation)\n\nRun directly without installing:\n\n```bash\nuvx nextpy-cli my-project\n```\n\n**Advantages:**\n- \u26a1 10-100x faster than pip\n- \u2705 No installation needed\n- \u2705 Isolated environment\n- \u2705 Always latest version\n\n### From PyPI\n\n```bash\n# Using pip\npip install nextpy-cli\n\n# Using uv (faster)\nuv pip install nextpy-cli\n\n# Using pipx (isolated)\npipx install nextpy-cli\n```\n\n### From Source\n\n```bash\ngit clone https://github.com/VesperAkshay/nextpy.git\ncd nextpy/python-cli\npip install -e .\n```\n\n### Installing uv/uvx\n\nIf you don't have `uv` installed:\n\n```bash\n# macOS/Linux\ncurl -LsSf https://astral.sh/uv/install.sh | sh\n\n# Windows\npowershell -c \"irm https://astral.sh/uv/install.ps1 | iex\"\n\n# Or with pip\npip install uv\n```\n\n## \ud83e\udd1d Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## \ud83d\udcc4 License\n\nMIT License - see the [LICENSE](https://github.com/VesperAkshay/nextpy/blob/main/LICENSE) file for details.\n\n## \ud83d\udd17 Links\n\n- [GitHub Repository](https://github.com/VesperAkshay/nextpy)\n- [Report Issues](https://github.com/VesperAkshay/nextpy/issues)\n- [PyPI Package](https://pypi.org/project/nextpy-cli/)\n- [npm Package](https://www.npmjs.com/package/nextpy)\n\n## \ud83d\udca1 Why NextPy?\n\n- **Save Time**: Skip the boilerplate and start building features immediately\n- **Best Practices**: Pre-configured with industry standards\n- **Flexible**: Choose your database and customize as needed\n- **Modern Stack**: Use the latest and greatest technologies\n- **Docker Ready**: Deploy anywhere with confidence\n- **Python-First**: Built by Python developers, for Python developers\n\n## \ud83d\udc1b Troubleshooting\n\n### Command not found after installation\n\nMake sure your Python scripts directory is in your PATH:\n\n```bash\n# On Linux/Mac\nexport PATH=\"$HOME/.local/bin:$PATH\"\n\n# On Windows\n# Add %APPDATA%\\Python\\Python311\\Scripts to your PATH\n```\n\n### Permission errors on Linux/Mac\n\n```bash\npip install --user nextpy-cli\n```\n\n## \ud83d\udcda Documentation\n\nFor more detailed documentation, visit our [GitHub repository](https://github.com/VesperAkshay/nextpy).\n\n---\n\nMade with \u2764\ufe0f by [VesperAkshay](https://github.com/VesperAkshay)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CLI tool to scaffold FastAPI + Next.js full-stack applications with Fox AI companion",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/VesperAkshay/nextpy",
"Issues": "https://github.com/VesperAkshay/nextpy/issues",
"Repository": "https://github.com/VesperAkshay/nextpy"
},
"split_keywords": [
"cli",
" fastapi",
" nextjs",
" vite",
" react",
" fullstack",
" scaffold",
" boilerplate",
" generator",
" python",
" typescript",
" docker",
" postgresql",
" mongodb",
" sqlite",
" ai",
" fox",
" intelligent",
" presets",
" preferences"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ae5f4c9216480a433f87e61aae3c539c283ff8b452fdd4471815461ccae29939",
"md5": "86b2d92b34a320843a58d34c57e74a8e",
"sha256": "83c876cc6dd21b7179a46aa19dfecbfeb0c0c801015b6caef85876b3c071429a"
},
"downloads": -1,
"filename": "nextpy_cli-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "86b2d92b34a320843a58d34c57e74a8e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 26433,
"upload_time": "2025-10-13T19:24:14",
"upload_time_iso_8601": "2025-10-13T19:24:14.800672Z",
"url": "https://files.pythonhosted.org/packages/ae/5f/4c9216480a433f87e61aae3c539c283ff8b452fdd4471815461ccae29939/nextpy_cli-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7afc9ae679002f6aa8123df1d93595931607f590cae25bb4f1ca7124d6f7c812",
"md5": "47a8c2aa541f4741c9893b5e50175cf4",
"sha256": "210c08b85b14b55a774f9855f1054ccc464e5032ad3ab8fd748bb6024d07bf7c"
},
"downloads": -1,
"filename": "nextpy_cli-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "47a8c2aa541f4741c9893b5e50175cf4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 26134,
"upload_time": "2025-10-13T19:24:15",
"upload_time_iso_8601": "2025-10-13T19:24:15.870391Z",
"url": "https://files.pythonhosted.org/packages/7a/fc/9ae679002f6aa8123df1d93595931607f590cae25bb4f1ca7124d6f7c812/nextpy_cli-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-13 19:24:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "VesperAkshay",
"github_project": "nextpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nextpy-cli"
}
JSON
