doc/readme.md

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