Skip to main content

Python API for HID-IO HID Layouts Repository

Project description

HID-IO layouts Python API

This is the Python API for the HID-IO layouts repository. By default, the API will download the latest version of the layouts git repository to use that as a cache.

The purpose of this API is to acquire and merge the JSON HID layouts. With some additional helpers to deal with string composition.

layouts is also available on PyPi.

pip install layouts

GitHub Action Status PyPI version

Visit our IRC channel

Usage

Some basic usage examples.

List Layouts

GitHub Cache

import layouts

mgr = layouts.Layouts()
print(mgr.list_layouts()

Local Cache

import layouts

layout_dir = "/tmp/mylayouts/layouts"
mgr = layouts.Layouts(layout_path=layout_dir)
print(mgr.list_layouts()

Retrieve Layout

import layouts

mgr = layouts.Layouts()
layout = mgr.get_layout('default')

print(layout.name()) # Name of merged layout
print(layout.json()) # Fully merged JSON dict
print(layout.locale()) # Tuple (<USB HID locale code>, <name>)

Composition Example

import layouts

mgr = layouts.Layouts()
layout = mgr.get_layout('default')

input_str = "Hello World!"
print(layout.compose(input_str))

# Only use code clears when necessary (blank USB packet)
print(layout.compose(input_str, minimal_clears=True))

Codes for C-Style Defines

import layouts
import layouts.emitter

mgr = layouts.Layouts()
layout = mgr.get_layout('default')

# Returns a list of list of tuples
# Each type of code has a pre-defined (configurable) prefix
# [<keyboard codes>, <led codes>, <system control codes>, <consumer codes>]
# (<name>, <code>)
# Useful for:
# #define KEY_A 0x04
print(layouts.emitter.basic_c_defines(layout))

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

layouts-0.4.10.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

layouts-0.4.10-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file layouts-0.4.10.tar.gz.

File metadata

  • Download URL: layouts-0.4.10.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.22.0

File hashes

Hashes for layouts-0.4.10.tar.gz
Algorithm Hash digest
SHA256 c20488550b887c5685480fa52cd9bd91305d73d36808307a23ef6607ade344b5
MD5 c485e54fbfb0fbe08ffd0ef3bec2611a
BLAKE2b-256 2f9c09e0bf37684be29bafa710f2abcca6b7891bbaca0d836e7cc8f3a7f8a077

See more details on using hashes here.

File details

Details for the file layouts-0.4.10-py3-none-any.whl.

File metadata

  • Download URL: layouts-0.4.10-py3-none-any.whl
  • Upload date:
  • Size: 9.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.22.0

File hashes

Hashes for layouts-0.4.10-py3-none-any.whl
Algorithm Hash digest
SHA256 78f44c43ed43bb80b45c311c603aa4aa554545d0215c29a74a56bbc86c11e74e
MD5 d46d85662cd376240baecbdfc5e8d211
BLAKE2b-256 2e5c75218896bef96ec432e157fa10bd6f32326e2bbfaff5916d07c9eabc6634

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page