Skip to main content

A professional Python SDK for the LobbyPMS API and Dashboard

Project description

LobbyPMS SDK

A professional, zero-dependency, fully-typed Python SDK for the LobbyPMS API and Administrative Dashboard.

Installation

pip install lobbypms-sdk

Features

  • Zero Dependencies: Built entirely on Python's standard library (urllib, ssl, json).
  • Fully Typed: Comprehensive TypedDict definitions for all API responses.
  • API & Dashboard Support: Access both the official v1/v2 API and the administrative panel (session/cookie based auth).
  • Pure Python: No external requirements like requests or dotenv.

Quick Start

1. Basic API Usage

from lobbypms import PMS

# Authentication is handled via parameter or environment variable (LOBBYPMS_API_TOKEN)
pms = PMS(api_token="your_token_here")

# Get rooms
rooms = pms.rooms()
print(rooms['data'])

2. Administrative Panel Authentication

from lobbypms import PMS

pms = PMS()

# 1. Get users for a hotel code
users = pms.get_panel_users('13814')

# 2. Login to the visual dashboard
success = pms.login_panel('13814', user_id='330414', password='your_password')

if success:
    # 3. Access dashboard-only endpoints
    notifications = pms.get_notifications()

Environment Variables

The SDK can automatically load the API token from the environment:

  • LOBBYPMS_API_TOKEN: Your API token.

It also supports a native fallback to read from a local .env file in the current working directory without requiring any external libraries.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request to lobbypms-sdk-python.

License

MIT

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

lobbypms_sdk-0.1.0.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

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

lobbypms_sdk-0.1.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file lobbypms_sdk-0.1.0.tar.gz.

File metadata

  • Download URL: lobbypms_sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for lobbypms_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d29bc48ebb54e6b2832c096f6c4a7ea61af96ddacdbddff101576cf63cb95d3e
MD5 908ec76a58318d2bb6a17832aa3c32d4
BLAKE2b-256 e38422e687f3b2d20d13f2544345c7bc1c3d2bb7ebfcd28404c0252a81750508

See more details on using hashes here.

File details

Details for the file lobbypms_sdk-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: lobbypms_sdk-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for lobbypms_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 00278bc0f6b6af005c5e875d3d63cee1eb8305a73d5154efd2b6c06bd0404c67
MD5 4eee24c89ce9105cb5abb66b1ea7d4c6
BLAKE2b-256 a2bd0d7b8aab455d7bbc57ddf83f1ad6e99ba36fa282a717ece91a8ed82d25c4

See more details on using hashes here.

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