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.0.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.0-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: adderlib-1.0.0.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.0.tar.gz
Algorithm Hash digest
SHA256 f98bfbc80fa368b7442699814d0adc15e93f0bd8c308e5230567205dfdb28f3c
MD5 d58794736682b3b0d19ae0c8b348a177
BLAKE2b-256 434031fb4409a745f51f180ae668b549d37bbed5434571e85e25d75c86ea718e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: adderlib-1.0.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 90b46f039e6fdc8765e06ca6008462b9a62d68b7ec610fa07fa29ff539bfb527
MD5 1f8234f9a73b387ff256466812be0821
BLAKE2b-256 dd123acf6ba5be2bfa404f45a6e16f4b127b2d249295e4763cb8f45cc53db6c6

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