Kisi
Overview
KISI: The go-to access control app.
This Python library provides convenient access to the Kisi API, allowing you to manage groups, calendars, and cameras programmatically. Kisi is an easy to use cloud based software to manage access to your doors. For physical access use your smartphone's mobile App or secure badges to unlock and open door.
Request Feature/Suggestion: https://forms.gle/efGD5DuTpWsX96GG7
Installation
pip install kisi
Kisi supports Python 3+.
Usage
Default
import kisi
Authentication
Before making requests, you need to authenticate using your Kisi API key. Initialize the Connect class with your API key:
from kisi import Connect
api_key = 'your_kisi_api_key'
ks = Connect(api_key)
OR
import kisi
api_key = 'your_kisi_api_key'
ks = kisi.Connect(api_key)
Generate Key from Kisi API
Groups
Fetching Groups
groups = ks.group.fetch_groups()
print(groups)
Creating a Group
new_group = ks.group.create_group(name='Engineering Team', description='Access to engineering floors')
print(new_group)
Fetching a Group
group_info = ks.group.fetch_group(group_id=123)
print(group_info)
Updating a Group
update_result = ks.group.update_group(group_id=123, name='New Name', description='New Description')
print(update_result)
Deleting a Group
delete_result = ks.group.delete_group(group_id=123)
print(delete_result)
Calendars
Fetching Calendar Summary
summary = ks.calendar.fetch_summary(around='2024-06-14', consequence='upcoming')
print(summary)
Cameras
Fetching Cameras
cameras = ks.camera.fetch_cameras()
print(cameras)
Creating a Camera
new_camera = ks.camera.create_camera(lock_id=456, remote_id='abc123', name='Office Camera')
print(new_camera)
Fetching a Camera
camera_info = ks.camera.fetch_camera(camera_id=789)
print(camera_info)
Updating a Camera
update_status = ks.camera.update_camera(camera_id=789, name='Updated Camera')
print(update_status)
Deleting a Camera
delete_status = ks.camera.delete_camera(camera_id=789)
print(delete_status)
License
This project is licensed under the MIT License - see the LICENSE file for details.
This `README.md` provides a structured guide to using your library, including installation instructions, usage examples for each API action (groups, calendars, cameras), and licensing information. Adjust the examples as needed to match the specifics of your API client implementation and usage scenarios.
Metadata
Release files for Kisi 1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| kisi-1.tar.gz | 5.5 kB | Without provenance | Details for kisi-1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| Kisi-1-py3-none-any.whl | Python 3 | none | any | Details for Kisi-1-py3-none-any.whl |
Total release size: 10.5 kB
Release files / kisi-1.tar.gz
| Download URL | kisi-1.tar.gz |
|---|---|
| Size | 5.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
488123b0134d4ed7503dbabd7b3cbd9a0e16a514652dad2a65992f466b2b62fe
|
|
BLAKE2b-256 checksum How to use checksums |
de5bc20f6cd24720f3bc441e0e37fda9556e229496334941333f115dd0c092c1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.4
|
Release files / Kisi-1-py3-none-any.whl
| Download URL | Kisi-1-py3-none-any.whl |
|---|---|
| Size | 5.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
aebe6a6125c9fc85e0bed2cb0e8749e78e0d47ae65b2f133620f3a2394dcc38b
|
|
BLAKE2b-256 checksum How to use checksums |
4559bf111f940bfe354d00dffc31775206ab8e9b53fb4ea7ab3fc4e01c0f4bf3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.4
|
Security for Kisi 1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.