# Rhamaa CLI
Simple CLI tool for Wagtail CMS development. Create projects and install prebuilt apps instantly.
## ⚡ Quick Start
```bash
# Install
pip install rhamaa
# Create Wagtail project
rhamaa start MyProject
cd MyProject
# Create minimal Django app
rhamaa startapp blog
# Install prebuilt app
rhamaa startapp iot --prebuild mqtt
# List available apps
rhamaa startapp --list
```
## 🎯 Two Simple Commands
### `rhamaa start <project>`
Creates new Wagtail project using RhamaaCMS template.
### `rhamaa startapp <name>`
Creates Django apps or installs prebuilt apps:
- `--type minimal` - Standard Django app (default)
- `--type wagtail` - Wagtail app with models/templates
- `--prebuild <key>` - Install from registry
- `--list` - Show available prebuilt apps
## 📦 Available Prebuilt Apps
| Key | Name | Category |
|-----|------|----------|
| `mqtt` | MQTT Apps | IoT |
| `users` | User Management | Authentication |
| `articles` | Article System | Content |
## 💡 Usage Examples
```bash
# Blog project
rhamaa start MyBlog
cd MyBlog
rhamaa startapp articles --prebuild articles
# IoT dashboard
rhamaa start IoTDash
cd IoTDash
rhamaa startapp devices --prebuild mqtt
# Educational platform
rhamaa start EduSite
cd EduSite
rhamaa startapp courses --prebuild lms
```
## 🔧 After Installing Apps
1. Add to `INSTALLED_APPS`:
```python
INSTALLED_APPS = [
# ... existing apps
'apps.your_app_name',
]
```
2. Run migrations:
```bash
python manage.py makemigrations
python manage.py migrate
```
## 🚀 Features
- **Rich Terminal UI** - Beautiful ASCII art and progress bars
- **Auto Directory Structure** - Apps created in `apps/` folder
- **GitHub Integration** - Downloads apps from repositories
- **Force Install** - Overwrite existing apps with `--force`
- **Project Detection** - Validates Wagtail project structure
## 📋 Requirements
- Python 3.7+
- Django/Wagtail (for project creation)
## 🔗 Links
- [Documentation](https://rhamaacms.github.io/RhamaaCLI)
- [PyPI Package](https://pypi.org/project/rhamaa/)
- [GitHub Repository](https://github.com/RhamaaCMS/RhamaaCLI)
- [Issues & Support](https://github.com/RhamaaCMS/RhamaaCLI/issues)
---
Made with ❤️ by the [RhamaaCMS](https://github.com/RhamaaCMS) team
Raw data
{
"_id": null,
"home_page": "https://github.com/RhamaaCMS/RhamaaCLI",
"name": "rhamaa",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "RhamaaCMS Team <contact@rhamaacms.com>",
"keywords": "wagtail, django, cms, cli, rhamaa, code-generator",
"author": "RhamaaCMS Team",
"author_email": "RhamaaCMS Team <contact@rhamaacms.com>",
"download_url": "https://files.pythonhosted.org/packages/c6/64/0ce4037c9c99eeac6f3d025b817fece16d8d08322a89c43c760b3d925080/rhamaa-0.3.1.tar.gz",
"platform": null,
"description": "# Rhamaa CLI\n\nSimple CLI tool for Wagtail CMS development. Create projects and install prebuilt apps instantly.\n\n## \u26a1 Quick Start\n\n```bash\n# Install\npip install rhamaa\n\n# Create Wagtail project\nrhamaa start MyProject\ncd MyProject\n\n# Create minimal Django app\nrhamaa startapp blog\n\n# Install prebuilt app\nrhamaa startapp iot --prebuild mqtt\n\n# List available apps\nrhamaa startapp --list\n```\n\n## \ud83c\udfaf Two Simple Commands\n\n### `rhamaa start <project>`\nCreates new Wagtail project using RhamaaCMS template.\n\n### `rhamaa startapp <name>`\nCreates Django apps or installs prebuilt apps:\n- `--type minimal` - Standard Django app (default)\n- `--type wagtail` - Wagtail app with models/templates\n- `--prebuild <key>` - Install from registry\n- `--list` - Show available prebuilt apps\n\n## \ud83d\udce6 Available Prebuilt Apps\n\n| Key | Name | Category |\n|-----|------|----------|\n| `mqtt` | MQTT Apps | IoT |\n| `users` | User Management | Authentication |\n| `articles` | Article System | Content |\n\n## \ud83d\udca1 Usage Examples\n\n```bash\n# Blog project\nrhamaa start MyBlog\ncd MyBlog\nrhamaa startapp articles --prebuild articles\n\n# IoT dashboard\nrhamaa start IoTDash\ncd IoTDash\nrhamaa startapp devices --prebuild mqtt\n\n# Educational platform\nrhamaa start EduSite\ncd EduSite\nrhamaa startapp courses --prebuild lms\n```\n\n## \ud83d\udd27 After Installing Apps\n\n1. Add to `INSTALLED_APPS`:\n```python\nINSTALLED_APPS = [\n # ... existing apps\n 'apps.your_app_name',\n]\n```\n\n2. Run migrations:\n```bash\npython manage.py makemigrations\npython manage.py migrate\n```\n\n## \ud83d\ude80 Features\n\n- **Rich Terminal UI** - Beautiful ASCII art and progress bars\n- **Auto Directory Structure** - Apps created in `apps/` folder\n- **GitHub Integration** - Downloads apps from repositories\n- **Force Install** - Overwrite existing apps with `--force`\n- **Project Detection** - Validates Wagtail project structure\n\n## \ud83d\udccb Requirements\n\n- Python 3.7+\n- Django/Wagtail (for project creation)\n\n## \ud83d\udd17 Links\n\n- [Documentation](https://rhamaacms.github.io/RhamaaCLI)\n- [PyPI Package](https://pypi.org/project/rhamaa/)\n- [GitHub Repository](https://github.com/RhamaaCMS/RhamaaCLI)\n- [Issues & Support](https://github.com/RhamaaCMS/RhamaaCLI/issues)\n\n---\n\nMade with \u2764\ufe0f by the [RhamaaCMS](https://github.com/RhamaaCMS) team\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CLI tools to accelerate Wagtail web development with RhamaaCMS",
"version": "0.3.1",
"project_urls": {
"Bug Reports": "https://github.com/RhamaaCMS/RhamaaCLI/issues",
"Documentation": "https://github.com/RhamaaCMS/RhamaaCLI/wiki",
"Homepage": "https://github.com/RhamaaCMS/RhamaaCLI",
"Repository": "https://github.com/RhamaaCMS/RhamaaCLI"
},
"split_keywords": [
"wagtail",
" django",
" cms",
" cli",
" rhamaa",
" code-generator"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5526df828231a6adeee6d86941130f533738429b493d703edb39623536115b3d",
"md5": "ec44903cdaed0ed40bd42797b194823e",
"sha256": "924771f505eadf4bb121a9ab3977d99a527eb42a40aa3edd48006f1867f8a828"
},
"downloads": -1,
"filename": "rhamaa-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ec44903cdaed0ed40bd42797b194823e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 20348,
"upload_time": "2025-09-09T05:44:58",
"upload_time_iso_8601": "2025-09-09T05:44:58.899428Z",
"url": "https://files.pythonhosted.org/packages/55/26/df828231a6adeee6d86941130f533738429b493d703edb39623536115b3d/rhamaa-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c6640ce4037c9c99eeac6f3d025b817fece16d8d08322a89c43c760b3d925080",
"md5": "3664c483c4c7d3ddffb757ab6c98d2a0",
"sha256": "b427c2a4af46b1096f9e0176872e9eca03d0b3408457e3f8c8a477d869b7de5e"
},
"downloads": -1,
"filename": "rhamaa-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "3664c483c4c7d3ddffb757ab6c98d2a0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 56548,
"upload_time": "2025-09-09T05:45:00",
"upload_time_iso_8601": "2025-09-09T05:45:00.637361Z",
"url": "https://files.pythonhosted.org/packages/c6/64/0ce4037c9c99eeac6f3d025b817fece16d8d08322a89c43c760b3d925080/rhamaa-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-09 05:45:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RhamaaCMS",
"github_project": "RhamaaCLI",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "rhamaa"
}
JSON
