Metadata-Version: 2.4
Name: jinks-core
Version: 0.0.1a1
Summary: Sub-package of jinks, a continuous e-ink widget display library.
License-Expression: AGPL-3.0
Project-URL: Repository, https://gitlab.com/azurennn/jinks
Project-URL: Documentation, https://jinks-ebd2b4.gitlab.io/
Project-URL: Issues, https://gitlab.com/Azurennn/jinks/-/work_items
Keywords: eink,e-ink,display,widget
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Home Automation
Requires-Python: >=3.12
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: pyyaml
Requires-Dist: pillow
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: jinks-test; extra == "test"
Provides-Extra: sentry
Requires-Dist: sentry-sdk; extra == "sentry"
Dynamic: license-file

.. image:: https://gitlab.com/azurennn/jinks/raw/main/assets/jinks.svg
   :target: https://jinks-ebd2b4.gitlab.io/
   :align: center
   :height: 200
   :alt: jinks


------

.. image:: https://img.shields.io/pypi/v/jinks.svg
    :target: https://pypi.org/project/jinks-core/

.. image:: https://img.shields.io/pypi/pyversions/jinks.svg
    :target: https://pypi.org/project/jinks-core/

.. image:: https://gitlab.com/Azurennn/jinks/badges/main/pipeline.svg
    :target: https://gitlab.com/Azurennn/jinks/-/commits/main
    :alt: pipeline status

.. image:: https://gitlab.com/Azurennn/jinks/badges/main/coverage.svg
    :target: https://gitlab.com/Azurennn/jinks/-/commits/main
    :alt: coverage report

..
    .. image:: https://readthedocs.org/projects/jinks/badge/?version=latest
        :target: https://jinks.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

|

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

This is the ``jinks-core`` package, a sub-package included in the ``jinks`` library.

Install
-------

With pipx

.. code-block:: shell

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

With pip

.. code-block:: shell

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

For developers

.. code-block:: shell

    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 <https://jinks-ebd2b4.gitlab.io/>`__.


Bugs/Requests
-------------

Please use the `Gitlab issues <https://gitlab.com/azurennn/jinks/issues>`__
to submit bugs or request features.


License
-------

Copyright Jules Anderson, 2026.

Distributed under the terms of the `GNU AGPLv3`_ license.

.. _`GNU AGPLv3`: https://gitlab.com/azurennn/jinks/main/LICENSE
