Skip to main content

Installer for the prefiq CLI tool

Project description

Prefiq CLI

Modern Full-Stack App Scaffolding Tool
Build, manage, and scale modular Python projects with ease.

Latest Release Downloads License Build Status


1. Install Prefiq

pip install prefiq

Or use the installer script:

python install_prefiq.py

2. Create a New Project

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:

cd sundar

▶️ Full App Scaffold

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

prefiq new-app auth --base

Generates only the essential app folders and files.

♻️ Force Overwrite an Existing App

prefiq new-app blog --force

This will overwrite the existing apps/blog folder.


🧩 Manage Apps

List Registered Apps

prefiq list-apps

Remove an App

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


📜 License

This project is licensed under the MIT License.


🔐 Security Policy

If you discover a vulnerability, please submit an issue or contact us directly. See 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.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

prefiq_installer-1.1.8.tar.gz (82.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

prefiq_installer-1.1.8-py3-none-any.whl (30.4 kB view details)

Uploaded Python 3

File details

Details for the file prefiq_installer-1.1.8.tar.gz.

File metadata

  • Download URL: prefiq_installer-1.1.8.tar.gz
  • Upload date:
  • Size: 82.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for prefiq_installer-1.1.8.tar.gz
Algorithm Hash digest
SHA256 1c84572cf19f77ae1cd267a3f16e12bc8bb0da60391a0b5f01981617b50fdb43
MD5 18c91ed27ae93bd3038ce1fa97c41402
BLAKE2b-256 fcbd58328de6a87894b2b6942c4fd57339dfcd20753d0cbddd09ab88d678d33c

See more details on using hashes here.

Provenance

The following attestation bundles were made for prefiq_installer-1.1.8.tar.gz:

Publisher: publish.yml on PREFIQ/prefiq-installer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file prefiq_installer-1.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for prefiq_installer-1.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 600ff27ace8544de39bb8cecf610a9cf188b7e177aa0b71fc79454a606765942
MD5 693a6b8762d91567fe5388e7c2b68d04
BLAKE2b-256 8e4126868c2f4e3fd246b2c11d52bf7ddd85d15a626612cbee5d960330e6252d

See more details on using hashes here.

Provenance

The following attestation bundles were made for prefiq_installer-1.1.8-py3-none-any.whl:

Publisher: publish.yml on PREFIQ/prefiq-installer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page