|ci| |coveralls| |docs|
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_.
.. _full documentation: http://pywayland.readthedocs.org/
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.
.. _cheese shop: https://pypi.python.org/pypi/pywayland/ .. _git repository: https://github.com/flacjacket/pywayland/
Installing PyWayland requires the Wayland library and the headers to be installed.
PyWayland requires the cffi_ package to be installed. PyWayland runs and is
tested against Python 3.6+, including sufficient versions of PyPy3 (see
Running Tests_).
See the installation guide_ for more information on installing required dependencies
.. _cffi: https://cffi.readthedocs.org/ .. _installation guide: http://pywayland.readthedocs.org/en/latest/install.html#installation
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_.
.. _installing from source: http://pywayland.readthedocs.org/en/latest/install.html#installing-from-source
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
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.
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.
.. |ci| image:: https://github.com/flacjacket/pywayland/actions/workflows/ci.yml/badge.svg :target: https://github.com/flacjacket/pywayland/actions :alt: Build Status .. |coveralls| image:: https://coveralls.io/repos/flacjacket/pywayland/badge.svg :target: https://coveralls.io/r/flacjacket/pywayland :alt: Build Coverage .. |docs| image:: https://readthedocs.org/projects/pywayland/badge/?version=latest :target: https://pywayland.readthedocs.io/en/latest/ :alt: Documentation Status
FAQs
Python bindings for the libwayland library written in pure Python
We found that pywayland demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.