README.rst

   1 pylibacl
   2 ========
   3
   4 This is a Python 2.7+ 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 2.7 or newer.
  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 Note: to build from source, by default, Python 3 is needed. It can
  52 still be built with Python 2, by calling `make PYTHON=python2`.
  53
  54 FreeBSD
  55 +++++++
  56
  57 Note that on FreeBSD, ACLs are not enabled by default (at least on UFS
  58 file systems). To enable them, run `tunefs -a enabled` on the file
  59 system in question (after mounting it read-only). Then install:
  60
  61 - `pkg install py36-setuptools py36-sphinx`
  62
  63 or:
  64
  65 - `pkg install py37-setuptools`
  66
  67
  68 License
  69 -------
  70
  71 pylibacl is Copyright (C) 2002-2009, 2012, 2014, 2015 Iustin Pop.
  72
  73 pylibacl is free software; you can redistribute it and/or modify it under the
  74 terms of the GNU Lesser General Public License as published by the Free
  75 Software Foundation; either version 2.1 of the License, or (at your option) any
  76 later version. See the COPYING file for the full license terms.