Metadata-Version: 2.4
Name: prefiq-installer
Version: 1.1.9
Summary: Installer for the prefiq CLI tool
Home-page: https://github.com/PREFIQ/prefiq-py-cli
Author: Your Name
Author-email: you@example.com
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

<p align="center">
  <img src="images/logo.png" alt="Prefiq Logo" width="200"/>
</p>

<h1 align="center">Prefiq CLI</h1>

<p align="center">
  Modern Full-Stack App Scaffolding Tool<br>
  Build, manage, and scale modular Python projects with ease.
</p>

<p align="center">
  <img src="https://img.shields.io/github/v/release/PREFIQ/prefiq-py-cli" alt="Latest Release">
  <img src="https://img.shields.io/pypi/dm/prefiq" alt="Downloads">
  <img src="https://img.shields.io/github/license/PREFIQ/prefiq-py-cli" alt="License">
  <img src="https://img.shields.io/github/actions/workflow/status/PREFIQ/prefiq-py-cli/ci.yml" alt="Build Status">
</p>

---

### 1. Install Prefiq

```bash
pip install prefiq
````

Or use the installer script:

```bash
python install_prefiq.py
```

### 2. Create a New Project

```bash
prefiq install sundar
```

This sets up the `sundar/` project folder with:

* ✅ Python virtual environment (`venv/`)
* ✅ Standard files: `requirements.txt`, `README.md`, `LICENSE`, `.gitignore`
* ✅ Base framework folder: `prefentity/`

---

## 📁 Create Apps Using Templates

Inside your project folder:

```bash
cd sundar
```

### ▶️ Full App Scaffold

```bash
prefiq new-app crm
```

Creates a full app at `apps/crm/` with:

```
apps/
└── crm/
    ├── app.py
    ├── config.py
    ├── assets/
    ├── templates/
    ├── routes/
    ├── logic/
    ├── database/
    └── ...
```

### ⚡ Base (Minimal) App Scaffold

```bash
prefiq new-app auth --base
```

Generates only the essential app folders and files.

### ♻️ Force Overwrite an Existing App

```bash
prefiq new-app blog --force
```

This will overwrite the existing `apps/blog` folder.

---

## 🧩 Manage Apps

### List Registered Apps

```bash
prefiq list-apps
```

### Remove an App

```bash
prefiq remove-app blog
```

This will remove the folder and update `prefentity/manifest.json`.

---

## 🛠️ Features

* Modular app structure
* Plug-and-play scaffold templates
* Configurable base (`--base`) or full app generation
* Virtual environment setup
* Standardized project bootstrapping
* JSON-based app registry (`manifest.json`)

---

## 🤝 Contributing

We welcome contributions! To get started:[Contribute](CONTRIBUTING.md)

---

## 📜 License

This project is licensed under the [MIT License](LICENSE).

---

## 🔐 Security Policy

If you discover a vulnerability, please submit an issue or contact us directly. See [SECURITY.md](SECURITY.md) for guidelines.

---

## 📬 Contact

For support or questions, reach out via GitHub issues or email us at `support@prefiq.dev`.

---

> Built with passion by the **Prefiq** engineering team.

---
