Skip to content

horilla-opensource/horilla-setup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

4 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ› οΈ Horilla Setup CLI (horillasetup)

The Horilla Setup CLI is a lightweight, cross-platform command-line tool designed to streamline the initialization, migration, upgrade, and dependency management processes across the Horilla ecosystem β€” including HRMS v1, HRMS v2, and the newly released Horilla CRM.

It automates repetitive setup tasks like environment preparation, Git cloning, dependency installation, and migration handling β€” ensuring a smooth, consistent workflow for developers and deployment teams.


πŸš€ Key Features

βœ“ Quick project setup for HRMS (v1 & v2) and CRM βœ“ Version-aware migrations including HRMS v1 β†’ v2 upgrade βœ“ Automated dependency installation from requirements.txt βœ“ Seamless project upgrades via Git pull βœ“ Cross-platform support (Windows, Linux, macOS) βœ“ Single command workflow for setup, migration, and updates


βš™οΈ Installation

πŸ“¦ Global Installation (Recommended)

pip install horillasetup

🧩 Local Development Installation

If you’re improving or modifying the tool:

git clone https://github.com/horilla-opensource/setup.git cd horilla-ctl pip install -e .

-e installs the package in editable mode, so changes take effect instantly.


🧭 Usage Guide

Show all available commands:

horillasetup --help

πŸ—οΈ 1. Build a New Horilla Project

HRMS v1

horillasetup build hrms-v1

HRMS v2

horillasetup build hrms-v2

CRM (Newly Released πŸš€)

horillasetup build crm

The build command will:

  • Clone the correct Horilla repo (branch-specific)
  • Copy project files into the working directory
  • Install Python dependencies
  • Provide environment setup instructions

🧱 2. Run Migrations

HRMS v1

horillasetup migrate hrms-v1

HRMS v2

horillasetup migrate hrms-v2

CRM

horillasetup migrate crm

Migration steps include:

  • Running makemigrations
  • Applying migrations
  • Collecting static files

πŸ”„ 3. Upgrade an Existing Project

Pull latest code updates from Git:

HRMS v1

horillasetup upgrade hrms-v1

HRMS v2

horillasetup upgrade hrms-v2

CRM

horillasetup upgrade crm

πŸ” 4. HRMS v1 β†’ HRMS v2 Database Upgrade

To migrate an existing v1 database into v2:

horillasetup migrate hrms-v2 --existing

This performs:

  • Safe clearing of old migration entries
  • Faked compatibility migrations
  • Full v2 migration + static collection

πŸ“¦ 5. Install Dependencies Only

horillasetup install-deps

Installs all packages from requirements.txt.


πŸ’‘ Example Setup Workflow

# Build a fresh CRM project horillasetup build crm # Run CRM migrations horillasetup migrate crm # Upgrade project later horillasetup upgrade crm

πŸ›£οΈ Future Roadmap

  • πŸ”Œ Plugin-based scaffolding for new Horilla modules
  • πŸ” Automated version & dependency conflict detection
  • πŸ“¦ Project template generator
  • 🧰 Extended DevOps tools integration

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages