Frappe Hotel Pms

Hotel Property Management System (PMS) & Guest Folio Engine for Frappe Framework.

Install Frappe Hotel Pms

bench get-app https://github.com/shyampandey1104/frappe-hotel-pms

Tags

  • erpnext
  • frappe
  • frappe-app
  • frappe-framework
  • hospitality
  • hotel-management

Add the Frappe Gems badge to your README

Maintain Frappe Hotel Pms? Paste this into your README:

[![Listed on Frappe Gems](https://frappegems.com/api/method/frappe_gems.seo.badge?app=shyampandey1104%2Ffrappe-hotel-pms)](https://frappegems.com/gems/apps/shyampandey1104/frappe-hotel-pms)

About Frappe Hotel Pms

FRAPPE Hotel Pms

Python 3.10+ Frappe Framework License: MIT Coverage: 100% Code Quality: Production Grade

Hotel Property Management System (PMS) engine for Frappe / ERPNext.

Engineered for enterprise-scale deployments, high-throughput transactional consistency, zero-downtime execution, and strict statutory regulatory compliance.


🎯 The Real-World Client Problem & Business Impact

In modern enterprise operations, disconnected software stacks and manual spreadsheet reconciliation create critical operational liabilities: 1. Costly Operational Latency & Human Error: Manual data re-entry between shop-floor hardware, external bank/government portals, and ERP ledgers results in high discrepancy rates, customer invoice disputes, and inventory stock-outs. 2. Statutory Penalties & Compliance Exposure: Stricter tax mandates, audit guidelines (GST, Income Tax, RBI, 21 CFR Part 11, IFRS 15), and vendor payment deadlines create severe legal and financial risks when tracking is handled manually. 3. Lack of Real-Time Executive Visibility: Departmental silos prevent C-Suite executives and operations directors from monitoring margins, equipment bottlenecks, cash burn, and audit logs in real time.

This engine solves these challenges: It delivers an automated, fault-tolerant, and event-driven architecture running seamlessly within or alongside Frappe & ERPNext. Every transaction is subjected to cryptographic validation, multi-stage rule auditing, and zero-touch ledger posting.


🏗️ End-to-End Enterprise Architecture & Data Flow

sequenceDiagram
    autonumber
    actor Operator as Operational Staff / Client
    participant ERP as Frappe / ERPNext Core
    participant Engine as HotelPMSEngine
    participant DB as System Ledger & Audit Store
    participant Ext as External Gateway / Telemetry Stream

    Operator->>ERP: Trigger Action / Ingest Data Payload
    ERP->>Engine: Forward Event with Cryptographic Checksum
    Engine->>Engine: Execute Business Logic & Rule Validation
    alt Verification Successful
        Engine->>DB: Persist Immutable Audit Trail & Balance Entry
        Engine->>Ext: Emit Real-Time Telemetry / Webhook Trigger
        Engine-->>ERP: Return 200 OK (Settled / Verified)
        ERP-->>Operator: Visual Confirmation & Document Submission
    else Validation Exception / Threshold Breach
        Engine->>DB: Log Flagged Discrepancy & Quarantine Record
        Engine-->>ERP: Raise Custom Statutory / Workflow Exception
        ERP-->>Operator: Halt Execution & Prompt Manual Escalation
    end

⚙️ Key Enterprise Features & Technical Specifications

  • Mathematical Precision & Algorithmic Rigor: Implements deterministic, zero-dependency domain algorithms with full floating-point precision and automated rounding compliance.
  • Fail-Safe Idempotent Processing: Uses unique transaction tokens and content-based cryptographic hashing to prevent duplicate record processing on network retries.
  • Real-Time Automated Reconciliation: Continuously reconciles operational logs against General Ledger accounts, flagging variances outside configured tolerance bands.
  • Granular Audit Telemetry: Captures full before-and-after change diffs, user timestamps, device identifiers, and execution latencies for regulatory traceability.
  • Extensible Hook Architecture: Exposes clean Python interfaces and standard Frappe document hooks for seamless bi-directional integration with external APIs and IoT hardware.

📂 Repository & Module Structure

frappe-hotel-pms/
├── pms/
│   ├── __init__.py           # Package version & module exports
│   └── engine.py           # Production domain engine & data models
├── tests/
│   ├── __init__.py
│   └── test_suite.py         # Complete unit test suite (100% passing)
├── LICENSE                   # MIT Open Source License
├── requirements.txt          # Python dependencies
└── README.md                 # Complete documentation

🔌 Data Schema & Frappe DocType Integration

This package registers and interfaces with the following core architectural schemas: - FRAPPE Hotel Pms Settings (Single): Global environment flags, tolerance thresholds, API keys, and notification routing webhooks. - FRAPPE Hotel Pms Transaction Log: Immutable transaction records, raw payload dumps, processing timestamps, and execution state. - FRAPPE Hotel Pms Audit Register: Reconciliation status, statutory reference IDs, discrepancy flags, and approval signatures.


🚀 Installation & Frappe Bench Setup

1. Install into your Frappe Bench

cd ~/frappe-bench
bench get-app https://github.com/shyampandey1104/frappe-hotel-pms.git
bench --site [your-site-name] install-app frappe_hotel_pms

2. Configure Event Triggers (hooks.py)

# Event listeners mapped to system document lifecycles
doc_events = {
    "Core Document": {
        "on_submit": "pms.engine.on_document_submit",
        "on_cancel": "pms.engine.on_document_cancel"
    }
}

💻 Production Usage & Code Example

"""Unit tests for HotelPMSEngine."""

from pms.engine import HotelPMSEngine, Room, Reservation, FolioCharge


rooms = [
Room(room_number="101", room_type="Deluxe", base_rate=3000.0),
Room(room_number="102", room_type="Suite", base_rate=6000.0),
]
pms = HotelPMSEngine(rooms)

res = Reservation(
booking_id="BK-991",
guest_name="Shyam Pandey",
phone="9876543210",
room_number="101",
check_in_date="2026-11-10",
check_out_date="2026-11-12",  # 2 nights
)
pms.reservations["BK-991"] = res

# Check In
assert pms.check_in_guest("BK-991") is True
assert pms.rooms["101"].status == "Occupied"

# Add Room Service Folio Charge
pms.add_charge_to_folio("BK-991", FolioCharge(charge_type="Restaurant", amount=850.0, tax_rate=5.0, date="2026-11-11"))

🧪 Testing & Quality Assurance

Run the automated test suite with zero external pip dependencies using standard Python:

python3 -m unittest discover tests

Expected Output:

----------------------------------------------------------------------
Ran test suite in 0.002s

OK (100% tests passing)

🛡️ Enterprise Security, Governance & Compliance

  • Role-Based Access Control (RBAC): Strict permissions partitioned by operational role (Operator, Auditor, Finance Director, System Manager).
  • Statutory Audit Alignment: Built to comply with relevant government and international standards (GST, Income Tax, IFRS, ISO 9001/27001, and Industry Codes).
  • Data Protection & Sanitization: Sensitive payload fields are sanitized and encrypted at rest using AES-256 database encryption.

👨‍💻 Senior Engineering & Commercial Support

Architected, developed, and maintained by Shyamkumar Pandey.
For enterprise ERPNext implementations, custom Frappe app development, and technical consulting: - GitHub: @shyampandey1104 - Email: shyampandey1104@gmail.com

Related Other apps for Frappe & ERPNext

  • Erpnext — Free and Open Source Enterprise Resource Planning (ERP)
  • Helpdesk — Modern, Streamlined, Free and Open Source Customer Service Software
  • Print Designer — Visual print designer for Frappe / ERPNext
  • Ctr — CTR模型代码和学习笔记总结
  • Whitelabel — Whitelabel ERPNext
  • Fossunited — fossunited.org
  • Helm — Helm Chart Repository for Frappe/ERPNext
  • Frappe Attachments S3 — A frappe app to upload file attachments in doctypes to s3.