The Python X Library
====================
|Build Status| |codecov.io| |Code Health|
`Homepage`_ | `Releases`_ | `Changelog`_
Copyright
~~~~~~~~~
The main part of the code is
::
Copyright (C) 2000-2002 Peter Liljenberg
Some contributed code is copyrighted by `the contributors <Contributors_>`_,
in these cases that is indicated in the source files in question.
The Python X Library is released under LGPL v2.1 or later (since 2016),
see the file LICENSE for details. 0.15rc1 and before were released under
GPL v2.
Requirements
~~~~~~~~~~~~
The Python X Library requires Python 2.7 or newer. It has been tested to
various extents with Python 2.7 and 3.3 through 3.6.
The Python X Library will only work on systems that have an X server installed,
such as most Linux distros, but will not work on Windows or MacOS.
Installation
~~~~~~~~~~~~
The Python Xlib uses the standard setuptools package, to install run
this command:
::
python setup.py install
See the command help for details: ``python setup.py install -h``.
Alternatively, you can run programs from the distribution directory, or
change the module path in programs.
There's a simple example program, implemented twice using both the
high-level interface and the low-level protocol.
Introduction
~~~~~~~~~~~~
The Python X Library is intended to be a fully functional X client
library for Python programs. It is written entirely in Python, in
contrast to earlier X libraries for Python (the ancient X extension and
the newer plxlib) which were interfaces to the C Xlib.
This is possible to do since X client programs communicate with the X
server via the X protocol. The communication takes place over TCP/IP,
Unix sockets, DECnet or any other streaming network protocol. The C Xlib
is merely an interface to this protocol, providing functions suitable
for a C environment.
There are three advantages of implementing a pure Python library:
- Integration: The library can make use of the wonderful object system
in Python, providing an easy-to-use class hierarchy.
- Portability: The library will be usable on (almost) any computer
which have Python installed. A C interface could be problematic to
port to non-Unix systems, such as MS Windows or OpenVMS.
- Maintainability: It is much easier to develop and debug native Python
modules than modules written in C.
Documentation
~~~~~~~~~~~~~
The reference manual is not finished by far, but is probably still useful. It
can be `browsed online <https://python-xlib.github.io/>`__.
There are also some `example programs <Examples_>`_ and, of course,
`the standard X11 documentation <https://tronche.com/gui/x/xlib/>`__ applies.
Project status
~~~~~~~~~~~~~~
The low-level protocol is complete, implementing client-side X11R6. The
high-level object oriented interface is also fully functional. It is
possible to write client applications with the library. Currently, the
only real application using Python Xlib is the window manager PLWM,
starting with version 2.0.
There is a resource database implementation, ICCCM support and a
framework for adding X extension code. Several extensions have been
implemented (RECORD, SHAPE, Xinerama, Composite, RANDR, DAMAGE,
Generic Event, SECURITY, XFIXES, XInput, XTEST, NV-CONTROL, DPMS and XRes);
patches for additions are very welcome.
There are most likely still bugs, but the library is at least stable
enough to run PLWM. A continuously bigger part of the library is covered
by regression tests, improving stability.
The documentation is still quite rudimentary, but should be of some help
for people programming with the Xlib. X beginners should first find some
general texts on X. A very good starting point is
http://www.rahul.net/kenton/xsites.html
See the file TODO for a detailed list of what is missing, approximately
ordered by importance.
.. _Homepage: https://github.com/python-xlib/python-xlib
.. _Releases: https://github.com/python-xlib/python-xlib/releases
.. _Changelog: https://github.com/python-xlib/python-xlib/tree/master/CHANGELOG.md
.. _Contributors: https://github.com/python-xlib/python-xlib/graphs/contributors
.. _Examples: https://github.com/python-xlib/python-xlib/tree/master/examples
.. |Build Status| image:: https://travis-ci.org/python-xlib/python-xlib.svg?branch=master
:target: https://travis-ci.org/python-xlib/python-xlib
.. |codecov.io| image:: https://codecov.io/github/python-xlib/python-xlib/coverage.svg?branch=master
:target: https://codecov.io/github/python-xlib/python-xlib?branch=master
.. |Code Health| image:: https://landscape.io/github/python-xlib/python-xlib/master/landscape.svg?style=flat
:target: https://landscape.io/github/python-xlib/python-xlib/master
Raw data
{
"_id": null,
"home_page": "https://github.com/python-xlib/python-xlib",
"name": "python-xlib",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "windows,x,x11,xlib",
"author": "Peter Liljenberg",
"author_email": "petli@ctrl-c.liu.se",
"download_url": "https://files.pythonhosted.org/packages/86/f5/8c0653e5bb54e0cbdfe27bf32d41f27bc4e12faa8742778c17f2a71be2c0/python-xlib-0.33.tar.gz",
"platform": null,
"description": "The Python X Library\r\n====================\r\n\r\n|Build Status| |codecov.io| |Code Health|\r\n\r\n`Homepage`_ | `Releases`_ | `Changelog`_\r\n\r\nCopyright\r\n~~~~~~~~~\r\n\r\nThe main part of the code is\r\n\r\n::\r\n\r\n Copyright (C) 2000-2002 Peter Liljenberg\r\n\r\nSome contributed code is copyrighted by `the contributors <Contributors_>`_,\r\nin these cases that is indicated in the source files in question.\r\n\r\nThe Python X Library is released under LGPL v2.1 or later (since 2016),\r\nsee the file LICENSE for details. 0.15rc1 and before were released under\r\nGPL v2.\r\n\r\nRequirements\r\n~~~~~~~~~~~~\r\n\r\nThe Python X Library requires Python 2.7 or newer. It has been tested to\r\nvarious extents with Python 2.7 and 3.3 through 3.6.\r\n\r\nThe Python X Library will only work on systems that have an X server installed,\r\nsuch as most Linux distros, but will not work on Windows or MacOS.\r\n\r\nInstallation\r\n~~~~~~~~~~~~\r\n\r\nThe Python Xlib uses the standard setuptools package, to install run\r\nthis command:\r\n\r\n::\r\n\r\n python setup.py install\r\n\r\nSee the command help for details: ``python setup.py install -h``.\r\n\r\nAlternatively, you can run programs from the distribution directory, or\r\nchange the module path in programs.\r\n\r\nThere's a simple example program, implemented twice using both the\r\nhigh-level interface and the low-level protocol.\r\n\r\nIntroduction\r\n~~~~~~~~~~~~\r\n\r\nThe Python X Library is intended to be a fully functional X client\r\nlibrary for Python programs. It is written entirely in Python, in\r\ncontrast to earlier X libraries for Python (the ancient X extension and\r\nthe newer plxlib) which were interfaces to the C Xlib.\r\n\r\nThis is possible to do since X client programs communicate with the X\r\nserver via the X protocol. The communication takes place over TCP/IP,\r\nUnix sockets, DECnet or any other streaming network protocol. The C Xlib\r\nis merely an interface to this protocol, providing functions suitable\r\nfor a C environment.\r\n\r\nThere are three advantages of implementing a pure Python library:\r\n\r\n- Integration: The library can make use of the wonderful object system\r\n in Python, providing an easy-to-use class hierarchy.\r\n\r\n- Portability: The library will be usable on (almost) any computer\r\n which have Python installed. A C interface could be problematic to\r\n port to non-Unix systems, such as MS Windows or OpenVMS.\r\n\r\n- Maintainability: It is much easier to develop and debug native Python\r\n modules than modules written in C.\r\n\r\nDocumentation\r\n~~~~~~~~~~~~~\r\n\r\nThe reference manual is not finished by far, but is probably still useful. It\r\ncan be `browsed online <https://python-xlib.github.io/>`__.\r\n\r\nThere are also some `example programs <Examples_>`_ and, of course,\r\n`the standard X11 documentation <https://tronche.com/gui/x/xlib/>`__ applies.\r\n\r\n\r\nProject status\r\n~~~~~~~~~~~~~~\r\n\r\nThe low-level protocol is complete, implementing client-side X11R6. The\r\nhigh-level object oriented interface is also fully functional. It is\r\npossible to write client applications with the library. Currently, the\r\nonly real application using Python Xlib is the window manager PLWM,\r\nstarting with version 2.0.\r\n\r\nThere is a resource database implementation, ICCCM support and a\r\nframework for adding X extension code. Several extensions have been\r\nimplemented (RECORD, SHAPE, Xinerama, Composite, RANDR, DAMAGE,\r\nGeneric Event, SECURITY, XFIXES, XInput, XTEST, NV-CONTROL, DPMS and XRes);\r\npatches for additions are very welcome.\r\n\r\nThere are most likely still bugs, but the library is at least stable\r\nenough to run PLWM. A continuously bigger part of the library is covered\r\nby regression tests, improving stability.\r\n\r\nThe documentation is still quite rudimentary, but should be of some help\r\nfor people programming with the Xlib. X beginners should first find some\r\ngeneral texts on X. A very good starting point is\r\nhttp://www.rahul.net/kenton/xsites.html\r\n\r\nSee the file TODO for a detailed list of what is missing, approximately\r\nordered by importance.\r\n\r\n.. _Homepage: https://github.com/python-xlib/python-xlib\r\n.. _Releases: https://github.com/python-xlib/python-xlib/releases\r\n.. _Changelog: https://github.com/python-xlib/python-xlib/tree/master/CHANGELOG.md\r\n.. _Contributors: https://github.com/python-xlib/python-xlib/graphs/contributors\r\n.. _Examples: https://github.com/python-xlib/python-xlib/tree/master/examples\r\n\r\n.. |Build Status| image:: https://travis-ci.org/python-xlib/python-xlib.svg?branch=master\r\n :target: https://travis-ci.org/python-xlib/python-xlib\r\n.. |codecov.io| image:: https://codecov.io/github/python-xlib/python-xlib/coverage.svg?branch=master\r\n :target: https://codecov.io/github/python-xlib/python-xlib?branch=master\r\n.. |Code Health| image:: https://landscape.io/github/python-xlib/python-xlib/master/landscape.svg?style=flat\r\n :target: https://landscape.io/github/python-xlib/python-xlib/master\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "LGPLv2+",
"summary": "Python X Library",
"version": "0.33",
"split_keywords": [
"windows",
"x",
"x11",
"xlib"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "ea6a0a49716e64b2c82ed018c29a2bdf",
"sha256": "c3534038d42e0df2f1392a1b30a15a4ff5fdc2b86cfa94f072bf11b10a164398"
},
"downloads": -1,
"filename": "python_xlib-0.33-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ea6a0a49716e64b2c82ed018c29a2bdf",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 182185,
"upload_time": "2022-12-25T18:52:58",
"upload_time_iso_8601": "2022-12-25T18:52:58.662308Z",
"url": "https://files.pythonhosted.org/packages/fc/b8/ff33610932e0ee81ae7f1269c890f697d56ff74b9f5b2ee5d9b7fa2c5355/python_xlib-0.33-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "20a687ac84ee632aea9b9861206aa0eb",
"sha256": "55af7906a2c75ce6cb280a584776080602444f75815a7aff4d287bb2d7018b32"
},
"downloads": -1,
"filename": "python-xlib-0.33.tar.gz",
"has_sig": false,
"md5_digest": "20a687ac84ee632aea9b9861206aa0eb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 269068,
"upload_time": "2022-12-25T18:53:00",
"upload_time_iso_8601": "2022-12-25T18:53:00.824406Z",
"url": "https://files.pythonhosted.org/packages/86/f5/8c0653e5bb54e0cbdfe27bf32d41f27bc4e12faa8742778c17f2a71be2c0/python-xlib-0.33.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-25 18:53:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "python-xlib",
"github_project": "python-xlib",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"landscape": true,
"requirements": [],
"tox": true,
"lcname": "python-xlib"
}
JSON
