Skip to main content

Python wrapper for the Adder API, for use with Adderlink KVM systems

Project description

adderlib

adderlib is an unofficial python implementation of the Adder API, for use with Adderlink KVM systems.

With adderlib, you can:

  • Log in or out as an existing KVM user
  • Query lists of transmitters, receivers, and channels available to the user
  • Access many properties of the KVM devices
  • Connect receivers to channels
  • Manage presets

...and so much more! Well, a little bit more.

Getting Started

The best way to get started is to check out the examples, and then the official documentation on ReadTheDocs. But in general, it's four easy steps:

from adderlib import adder

# Step 1: Create a handle to the API by passing the IP address or hostname of the AIM (the KVM server)
api = adder.AdderAPI("192.168.1.10")

# Step 2: Log in using an exising KVM account
api.login("username","password")

# Step 3: Do some stuff
for tx in api.getTransmitters():
  do_some_stuff(tx)

# Step 4: Don't forget to log out!
api.logout()

Customizable

Boy oh boy is this customizable! An UrlHandler abstract class is provided. Subclass this and override the api_call() method to communicate with the server however you wish! I sure spent a lot of time on the default RequestsHandler class, which uses the requests library but that's ok I'm sure you have your reasons.

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

adderlib-1.0.1.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

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

adderlib-1.0.1-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file adderlib-1.0.1.tar.gz.

File metadata

  • Download URL: adderlib-1.0.1.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.5

File hashes

Hashes for adderlib-1.0.1.tar.gz
Algorithm Hash digest
SHA256 ac49e9856b04ce3a75f17f22312fb485ef9d0391a529a26312306bb94bac4c78
MD5 3c6afe2f970ffbec93c97d426d7c3e63
BLAKE2b-256 801804b538c9bd4494a4c6ddd65bb2392137501f08bfccd0c1434bf6f12ac84b

See more details on using hashes here.

File details

Details for the file adderlib-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: adderlib-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 12.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.5

File hashes

Hashes for adderlib-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 473728071eea15cc1fc90407207bbe299b26c8299ad370edf6806460f55f766f
MD5 1d0d15a7301637b99469981a6fa86a66
BLAKE2b-256 cedf2f9f5f3b255d7cd85be629f20e80264b782b994f58297b5a795cd0d04177

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