Skip to main content

Continuous e-ink widget display library.

Project description

jinks
https://img.shields.io/pypi/v/jinks.svg https://img.shields.io/pypi/pyversions/jinks.svg pipeline status coverage report

The jinks library and framework make it easy to create and display widgets on e-ink displays.

Install

With pipx

pipx install "jinks[raspberry-pi]"
jinks <config_file.yaml>

With pip

pip install "jinks[raspberry-pi]"
jinks <config_file.yaml>

For developers

git clone https://gitlab.com/azurennn/jinks.git
cd jinks
pip install -r requirements.txt

Features

  • Continuous customisable refresh and partial refresh times

  • Build your own widgets with ease in python or any other language with bindings (html/css bindings are an upcoming feature)

  • Sentry reporting

  • Automatic device setup (upcoming feature)

Documentation

For full documentation, including installation and tutorials, please see pages.

Bugs/Requests

Please use the Gitlab issues to submit bugs or request features.

License

Copyright Jules Anderson, 2026.

Distributed under the terms of the GNU AGPLv3 license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

jinks-0.0.1a1-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file jinks-0.0.1a1-py3-none-any.whl.

File metadata

  • Download URL: jinks-0.0.1a1-py3-none-any.whl
  • Upload date:
  • Size: 14.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for jinks-0.0.1a1-py3-none-any.whl
Algorithm Hash digest
SHA256 6791266b8c8622beb5b960e5a877cf9f2f4079d2a6d7c4a3899733eaa46c1ef5
MD5 0ff465ae9d77cffba4c938b6ff212616
BLAKE2b-256 cce93840d1e660d84903c4db5416578dffd44e0cbd2366a2d65c06c8f42bc381

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