doc/readme.md

   1 # pyxattr
   2
   3 This is the pyxattr module, a Python extension module which gives access
   4 to the extended attributes for filesystem objects available in some
   5 operating systems.
   6
   7 [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/iustin/pyxattr/CI)](https://github.com/iustin/pyxattr/actions/workflows/ci.yml)
   8 [![Codecov](https://img.shields.io/codecov/c/github/iustin/pyxattr)](https://codecov.io/gh/iustin/pyxattr)
   9 [![Read the Docs](https://img.shields.io/readthedocs/pyxattr)](http://pyxattr.readthedocs.io/en/latest/?badge=latest)
  10 [![GitHub issues](https://img.shields.io/github/issues/iustin/pyxattr)](https://github.com/iustin/pyxattr/issues)
  11 ![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/iustin/pyxattr)
  12 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/iustin/pyxattr)](https://github.com/iustin/pyxattr/releases)
  13 [![PyPI](https://img.shields.io/pypi/v/pyxattr)](https://pypi.org/project/pyxattr/)
  14 ![Debian package](https://img.shields.io/debian/v/python-pyxattr)
  15 ![Ubuntu package](https://img.shields.io/ubuntu/v/python-pyxattr)
  16 ![GitHub Release Date](https://img.shields.io/github/release-date/iustin/pyxattr)
  17 ![GitHub commits since latest release](https://img.shields.io/github/commits-since/iustin/pyxattr/latest)
  18 ![GitHub last commit](https://img.shields.io/github/last-commit/iustin/pyxattr)
  19
  20 Downloads: go to <https://pyxattr.k1024.org/downloads/>. The source
  21 repository is either at <http://git.k1024.org/pyxattr.git> or at
  22 <https://github.com/iustin/pyxattr>.
  23
  24 ## Requirements
  25
  26 The current supported Python versions are 3.7+ (tested up to 3.10), or
  27 PyPy versions 3.7+ (tested up to 3.9). The code should currently be
  28 compatible down to Python 3.4, but such versions are no longer tested.
  29
  30 The library has been written and tested on Linux, kernel v2.4 or
  31 later, with XFS and ext2/ext3/ext4 file systems, and MacOS recent
  32 versions. If any other platform implements the same behaviour,
  33 pyxattr could be used.
  34
  35 To build the module from source, you will need both a Python
  36 development environment/libraries and the C compiler, plus the
  37 setuptools tool installed, and for building the documentation you need
  38 to have Sphinx installed. The exact list of dependencies depends on
  39 the operating system/distribution, but should be something along the
  40 lines of `python3-devel` (RedHat), `python3-all-dev` (Debian), etc.
  41
  42 Alternatively, you can install directly from pip after installing the
  43 above depedencies (C compiler, Python development libraries):
  44
  45     pip install pyxattr
  46
  47 Or you can install already compiled versions from your distribution,
  48 e.g. in Debian:
  49
  50     sudo apt install python3-pyxattr
  51
  52 ## Basic example
  53
  54     >>> import xattr
  55     >>> xattr.listxattr("file.txt")
  56     ['user.mime_type']
  57     >>> xattr.getxattr("file.txt", "user.mime_type")
  58     'text/plain'
  59     >>> xattr.setxattr("file.txt", "user.comment", "Simple text file")
  60     >>> xattr.listxattr("file.txt")
  61     ['user.mime_type', 'user.comment']
  62     >>> xattr.removexattr ("file.txt", "user.comment")
  63
  64 ## License
  65
  66 pyxattr is Copyright 2002-2008, 2012-2015 Iustin Pop.
  67
  68 pyxattr is free software; you can redistribute it and/or modify it under the
  69 terms of the GNU Lesser General Public License as published by the Free
  70 Software Foundation; either version 2.1 of the License, or (at your option) any
  71 later version. See the COPYING file for the full license terms.
  72
  73 Note that previous versions had different licenses: version 0.3 was licensed
  74 under LGPL version 3 (which, I realized later, is not compatible with GPLv2,
  75 hence the change to LGPL 2.1), and even older versions were licensed under GPL
  76 v2 or later.