Skip to main content

API wrapper for ResidentPortal

Project description

ResidentPortal Python Client

Python client for interacting with ResidentPortal accounts.

This package is still in development and any part can be changed at anytime with no warning. PR's and feedback are welcome.

WARNING

The Resident Portal API is not public. Use at your own risk.

I can only test based on what I can see from using my account with the Resident Portal API, so any help would be great with testing and finding bugs. If one is encountered, please create a GitHub issue. The controllers and actions I could find are located in the repository under controllers.json, however, the HTTP method is not documented for each.

Install

pip install resident_portal

Usage

from resident_portal import User

rp = User("email@domain.com", "Password123!!", "subdomain")
await rp.login() # Log the client in
print(rp.leases) # List of leases user is associated with

lease = rp.leases[0] # First lease in the list
print(await lease.get_lease_balance()) # Get the leases balance

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

resident_portal-0.0.1.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

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

resident_portal-0.0.1-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file resident_portal-0.0.1.tar.gz.

File metadata

  • Download URL: resident_portal-0.0.1.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for resident_portal-0.0.1.tar.gz
Algorithm Hash digest
SHA256 938d48f6554c2f7d518b60f4df517cf66883894947b67e174f1297b2973ac958
MD5 a8e3aa20da44e4b6097c85c73d7c5c0b
BLAKE2b-256 71be08d03a795c2e7a4fd93517b739590fb3b4cd88874a8695a48527ec0d16f5

See more details on using hashes here.

File details

Details for the file resident_portal-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for resident_portal-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1c01331952271ae7617276ddacd7d5a4dd0500147ed95feac2589afef5403ca6
MD5 9d4d056f7ea61d209533618064669d9e
BLAKE2b-256 df4178f84cfc330c5824cc85d34a1a1e0928faf91165df1e86b4d6a58525984a

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