Skip to main content

Build Status Build Coverage Documentation Status

PyWayland provides a wrapper to the libwayland library using the CFFI library to provide access to the Wayland library calls and written in pure Python.

Below is outlined some of the basics of PyWayland and how to get up and running. For more help, see the full documentation.

Current Release

PyWayland is still in a developmental state. An current version is available on the cheese shop. Current development versions can be obtained from the git repository, feedback, as well as any bug reports or fixes are highly appreciated.

Dependencies

Installing PyWayland requires the Wayland library and the headers to be installed.

PyWayland requires the cffi package to be installed. See the installation guide for more information on installing required dependencies

Installing

Installation can be done through pip to pull the most recently tagged release. To see instructions on running from source, see the relevant documentation on installing from source.

Building Wayland protocols

In order to run from source, you will need to generate the interfaces to the Wayland protocol objects as defined in the wayland.xml file. By default, this file will be located in /usr/share/wayland/wayland.xml. In this case, the protocol files can be generated by the scanner module:

$ python -m pywayland.scanner

If pywayland._ffi is not built yet, run the scanner as a top-level module from the ./pywayland directory instead:

$ cd pywayland
$ python -m scanner

See the help for this module to use non-default locations for the input and output of the scanner.

The scanner is installed as a script pywayland-scanner when PyWayland is installed. See pywayland-scanner -h for more information.

Running Tests

PyWayland implements a (currently limited) test-suite in ./tests. The tests can be run through pytest. Be sure you build the protocol files (see Building Wayland protocols) before running the tests.

Metadata

Release files for pywayland 0.4.19

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pywayland 0.4.19
File Size Uploaded
pywayland-0.4.19.tar.gz 280.4 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for pywayland 0.4.19
File
pywayland-0.4.19-pp311-pypy311_pp73-manylinux_2_34_x86_64.whl PyPy 3.11 PyPy 3.11 7.3 Linux glibc 2.34+ x86-64 Details
pywayland-0.4.19-cp314-cp314-manylinux_2_34_x86_64.whl CPython 3.14 CPython 3.14 Linux glibc 2.34+ x86-64 Details
pywayland-0.4.19-cp313-cp313-manylinux_2_34_x86_64.whl CPython 3.13 CPython 3.13 Linux glibc 2.34+ x86-64 Details
pywayland-0.4.19-cp312-cp312-manylinux_2_34_x86_64.whl CPython 3.12 CPython 3.12 Linux glibc 2.34+ x86-64 Details
pywayland-0.4.19-cp311-cp311-manylinux_2_34_x86_64.whl CPython 3.11 CPython 3.11 Linux glibc 2.34+ x86-64 Details
pywayland-0.4.19-cp310-cp310-manylinux_2_34_x86_64.whl CPython 3.10 CPython 3.10 Linux glibc 2.34+ x86-64 Details

Total release size: 4.4 MB

Release files / pywayland-0.4.19.tar.gz

Download URL pywayland-0.4.19.tar.gz
Size 280.4 kB
Tags Source
SHA-256 checksum
How to use checksums
9d8478f5b0df3540333ccf85a55fe8b34150b2c28c685805de9ffa855898549e
BLAKE2b-256 checksum
How to use checksums
ef4381da8524a9e81bee3cd4d8bd1752de34031060e8011d2d3d1e9950840d6f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / pywayland-0.4.19-pp311-pypy311_pp73-manylinux_2_34_x86_64.whl

Download URL pywayland-0.4.19-pp311-pypy311_pp73-manylinux_2_34_x86_64.whl
Size 631.5 kB
Tags Linux glibc 2.34+ x86-64 PyPy 3.11 PyPy 3.11 7.3
SHA-256 checksum
How to use checksums
46ece208f847900ff33b753eaaeaa0ff350ef0d6880b14b6b89d2d71c3b2dade
BLAKE2b-256 checksum
How to use checksums
76a9a740a45412a3486bda29de37ed8950de884bc38ee5b626ee4006f0c95561
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / pywayland-0.4.19-cp314-cp314-manylinux_2_34_x86_64.whl

Download URL pywayland-0.4.19-cp314-cp314-manylinux_2_34_x86_64.whl
Size 705.1 kB
Tags CPython 3.14 Linux glibc 2.34+ x86-64
SHA-256 checksum
How to use checksums
51bba0917ba7815a4db75a3ecf7efe4683d4d78e861d59f83f7efade719faedb
BLAKE2b-256 checksum
How to use checksums
27e810f36b4db54bcccfc906c2939333e9b6482ca953f5a36a61fb5c7ed8518e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / pywayland-0.4.19-cp313-cp313-manylinux_2_34_x86_64.whl

Download URL pywayland-0.4.19-cp313-cp313-manylinux_2_34_x86_64.whl
Size 705.3 kB
Tags CPython 3.13 Linux glibc 2.34+ x86-64
SHA-256 checksum
How to use checksums
267e24092fefad19b0d8c4ca79ed11f9e6ab8074a4953d6dbbba1b180ec36363
BLAKE2b-256 checksum
How to use checksums
a322dc49766cb01d174d5f1f55620385436bd8032547d6196aef22c8fec991e2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / pywayland-0.4.19-cp312-cp312-manylinux_2_34_x86_64.whl

Download URL pywayland-0.4.19-cp312-cp312-manylinux_2_34_x86_64.whl
Size 705.3 kB
Tags CPython 3.12 Linux glibc 2.34+ x86-64
SHA-256 checksum
How to use checksums
1cde2f1f133f5f8d6974014969bad64789c5d2b129acbe212a9425805c65fe2b
BLAKE2b-256 checksum
How to use checksums
ab4620d628982baab0f57df815e2ba6b34b4f08a8111edd65eeb831dd6bcd5c3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / pywayland-0.4.19-cp311-cp311-manylinux_2_34_x86_64.whl

Download URL pywayland-0.4.19-cp311-cp311-manylinux_2_34_x86_64.whl
Size 704.1 kB
Tags CPython 3.11 Linux glibc 2.34+ x86-64
SHA-256 checksum
How to use checksums
f60860fd181d2420a6cb931cb91db49592691f7f6834eb4ce956de11abe2321a
BLAKE2b-256 checksum
How to use checksums
d4fedf2e2249cddb74b6e0815f5535afd3fbfc028be597dc60de526879b98611
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / pywayland-0.4.19-cp310-cp310-manylinux_2_34_x86_64.whl

Download URL pywayland-0.4.19-cp310-cp310-manylinux_2_34_x86_64.whl
Size 704.1 kB
Tags CPython 3.10 Linux glibc 2.34+ x86-64
SHA-256 checksum
How to use checksums
482ae6c2a664560716a1f72fc53ce58a1f83e6340eb59c1ebfc8b7c9c2f3d06f
BLAKE2b-256 checksum
How to use checksums
7df879e147b8c9ca2e2c01f8f192d527190cf27b6b264c6825ee9c6655b8a45a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page