Fix tests path in MANIFEST.in
[pylibacl.git] / README.rst
1 pylibacl
2 ========
3
4 This is a Python 3.4+ extension module allows you to manipulate the
5 POSIX.1e Access Control Lists present in some OS/file-systems
6 combinations.
7
8 Downloads: go to http://pylibacl.k1024.org/downloads. Latest version
9 is 0.5.4. The source repository is either at
10 https://git.k1024.org/pylibacl.git or at
11 https://github.com/iustin/pylibacl.
12
13 For any issues, please file bugs at
14 https://github.com/iustin/pylibacl/issues.
15
16 .. image:: https://img.shields.io/travis/iustin/pylibacl
17     :alt: Travis CI
18     :target: https://travis-ci.org/iustin/pylibacl
19 .. image:: https://img.shields.io/coveralls/github/iustin/pylibacl
20     :alt: Coveralls coverage
21     :target: https://coveralls.io/github/iustin/pylibacl?branch=master
22 .. image:: https://img.shields.io/github/release-date/iustin/pylibacl
23     :alt: GitHub Release Date
24 .. image:: https://img.shields.io/pypi/v/pylibacl
25     :alt: PyPI
26     :target: https://pypi.org/project/pylibacl/
27 .. image:: https://img.shields.io/pypi/implementation/pylibacl
28     :alt: PyPI - Implementation
29 .. image:: https://img.shields.io/pypi/dm/pylibacl
30     :alt: PyPI - Downloads
31
32 Requirements
33 ------------
34
35 pylibacl has been written and tested on Linux, kernel v2.4 or newer,
36 with XFS filesystems; ext2/ext3 should also work. Since release 0.4.0,
37 FreeBSD 7 also has quite good support. If any other platform
38 implements the POSIX.1e draft, pylibacl can be used. I heard that
39 Solaris does, but I can't test it.
40
41 - Python 3.4 or newer. Python 2.4+ was supported in the 0.5.x branch.
42 - Operating system:
43     - Linux, kernel v2.4 or newer, and the libacl library and
44       development packages (all modern distributions should have this,
45       under various names); also the file-systems you use must have
46       ACLs turned on, either as a compile or mount option.
47     - FreeBSD 7.0 or newer.
48 - The sphinx python module, for your python version, if building the
49   documentation.
50
51 FreeBSD
52 +++++++
53
54 Note that on FreeBSD, ACLs are not enabled by default (at least on UFS
55 file systems). To enable them, run `tunefs -a enabled` on the file
56 system in question (after mounting it read-only). Then install:
57
58 - `pkg install py36-setuptools py36-sphinx`
59
60 or:
61
62 - `pkg install py37-setuptools`
63
64
65 License
66 -------
67
68 pylibacl is Copyright (C) 2002-2009, 2012, 2014, 2015 Iustin Pop.
69
70 pylibacl is free software; you can redistribute it and/or modify it under the
71 terms of the GNU Lesser General Public License as published by the Free
72 Software Foundation; either version 2.1 of the License, or (at your option) any
73 later version. See the COPYING file for the full license terms.