BSD Ports

sysutils/py-qmk 1.2.0 FreeBSD

CLI program for working with QMK firmware

System
FreeBSD
Repository
FreeBSD ports
Maintainer
[email protected]
License
MIT
Categories
sysutils, python
Package size
32.6 KiB, 128.4 KiB installed

Description

A program to help users work with QMK keyboard firmware.

Features:

  • Interact with your qmk_firmware tree from any location
  • Use qmk clone to pull down anyone's qmk_firmware fork
  • Setup your build environment with qmk setup
  • Check that your environment is correctly setup with qmk doctor

Install

Binary package:

pkg install py312-qmk

From the ports tree:

cd /usr/ports/sysutils/py-qmk/ && make install clean

To depend on this port in another port's Makefile:

RUN_DEPENDS=	py312-qmk>0:sysutils/py-qmk

Packages

The version each package repository carries. “-” means the repository builds no package of it, “n/a” that there is no such repository.

Repositoryaarch64amd64armv6armv7i386
FreeBSD:14:latest1.2.01.2.0-1.1.81.2.0
FreeBSD:14:quarterly1.2.01.2.0n/a1.1.5_11.2.0
FreeBSD:15:latest1.2.01.2.0n/a1.1.81.1.8
FreeBSD:15:quarterly1.2.01.2.0n/an/an/a
FreeBSD:16:latest--n/an/an/a
FreeBSD:16:quarterlyn/an/an/an/an/a

Dependencies

As this port's Makefile names them.

Runtime 18

The full lists below include those, and their dependencies in turn.

Build dependencies 11
Run dependencies 67

No port depends on this one.

Configuration

No options to configure.

USES
python shebangfix
Service scripts
none

Message after installing

Setup
=====

Before finishing the setup of QMK by running `qmk setup`, it is advised to
install the python3 package first:

    # pkg install python3

The reason for this is that the qmk_firmware scripts which are downloaded
during the setup expect python3 to be installed (instead of /usr/local/bin/python3.12).

Granting Write Permissions to USB Controllers
=============================================

Flashing images to controllers as a non-root user requires
some additional setup:

1. Add the user to the "operator" group:

        # pw groupmod operator -m piotr

2. Add the following ruleset to /etc/devfs.rules:

        [qmk=10]
        add path 'ttyU*' mode 0660 group operator

3. Enable "qmk" ruleset:

        # sysrc devfs_set_rulesets+="/dev=qmk"

4. Restart the devfs service to load the new rules:

        # service devfs restart

Files

distinfo 1
FileSizeSHA256
qmk-1.2.0.tar.gz14152164bd16c4c401b2b765ee4f017bcfa8141942ddf362961c4cba1975d8cb28a48
Master sites 1
  • PYPI

Commit history 0

No commits in the history this site was built from.