Add a distcheck Makefile target
[pyxattr.git] / 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 [![Travis](https://img.shields.io/travis/iustin/pyxattr)](https://travis-ci.org/iustin/pyxattr)
8 [![Coveralls github](https://img.shields.io/coveralls/github/iustin/pyxattr)](https://coveralls.io/github/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 pyxattr has been written and tested on Linux, kernel v2.4 or later,
27 with XFS and ext2/ext3/ext3 file systems. If any other platform
28 implements the same behaviour, pyxattr could be used.
29
30 You need to have the setuptools tool installed in order to build and
31 install the module, and for building the documentation you need to
32 have Sphinx installed.
33
34 Alternatively, you can install directly from pip:
35
36     $ pip install pyxattr
37
38 Or from your distribution, e.g. in Debian:
39
40     $ sudo install python3-pyxattr
41
42 ## Basic example
43
44     >>> import xattr
45     >>> xattr.listxattr("file.txt")
46     ['user.mime_type']
47     >>> xattr.getxattr("file.txt", "user.mime_type")
48     'text/plain'
49     >>> xattr.setxattr("file.txt", "user.comment", "Simple text file")
50     >>> xattr.listxattr("file.txt")
51     ['user.mime_type', 'user.comment']
52     >>> xattr.removexattr ("file.txt", "user.comment")
53
54 ## License
55
56 pyxattr is Copyright 2002-2008, 2012-2015 Iustin Pop.
57
58 pyxattr is free software; you can redistribute it and/or modify it under the
59 terms of the GNU Lesser General Public License as published by the Free
60 Software Foundation; either version 2.1 of the License, or (at your option) any
61 later version. See the COPYING file for the full license terms.
62
63 Note that previous versions had different licenses: version 0.3 was licensed
64 under LGPL version 3 (which, I realized later, is not compatible with GPLv2,
65 hence the change to LGPL 2.1), and even older versions were licensed under GPL
66 v2 or later.