fileperms 1.2.0
fileperms is small library for describing file permissions
License: MIT
Keywords: files,permissions,posix

fileperms
==========

`fileperms` helps you read, change and set file permissions

Current stable version
----------------------

1.2.0

Features
--------

* easy manipulating of file permissions
* works fine with `os.chmod` and `pathlib.Path`

Python version
--------------

`fileperms` works only with Python 3.7+. Older Python versions are supported with older package versions.

Some examples
-------------

    # Some helper
    >>> def show_permissions(path):
    >>>     print(stat.filemode(os.stat(path).st_mode))
    >>>

    # Create Permissions object from existing file:
    >>> import fileperms
    >>> fileperms.Permissions.from_path('/etc')
    <Permissions(0755)>

    # Or shorter:
    >>> fileperms.from_path('/etc')
    <Permissions(0755)>

    # We are working on object with permissions 0600 / rw-------
    >>> import os, stat
    >>> show_permissions(path)
    -rw-------

    # Verify that
    >>> prm = fileperms.from_path(path)
    >>> prm
    <Permissions(0600)>
    >>> prm.to_filemode()
    'rw-------'

    # Change them a little using os.chmod
    >>> prm.owner_exec = True
    # or using setter:
    >>> prm.set(fileperms.Permission.other_exec, True)
    >>> os.chmod(path, int(prm))
    >>> show_permissions(path)
    -rwx-----x

    # Change them more, using pathlib module this time
    >>> import pathlib
    >>> path = pathlib.Path(path)
    >>> prm.group_read = True
    >>> prm.group_write = True
    >>> path.chmod(int(prm))
    >>> show_permissions(path)
    -rwxrw---x

    # You can also use Permissions.apply method for
    # applying same permissions to other objects:
    >>> prm.other_read = True
    >>> prm.apply(path)
    >>> show_permissions(path)
    -rwxrwxr-x

Installation
------------

1. Using PIP

`fileperms` should work on any platform where [Python](http://python.org)
is available, it means Linux, Windows, MacOS X etc, but is not tested on Windows.

Simplest way is to use Python's built-in package system:

    python -m pip install fileperms

2. Using sources

Download sources from [Github](https://github.com/msztolcman/fileperms/archive/1.2.0.zip):

    wget -O 1.2.0.zip https://github.com/msztolcman/fileperms/archive/1.2.0.zip

or

    curl -o 1.2.0.zip https://github.com/msztolcman/fileperms/archive/1.2.0.zip

Unpack:

    unzip 1.2.0.zip

And install

    cd fileperms-1.2.0
    python setup.py install

Voila!

Authors
-------

Marcin Sztolcman <marcin@urzenia.net>

Contact
-------

If you like or dislike this software, please do not hesitate to tell me about
this me via email (marcin@urzenia.net).

If you find bug or have an idea to enhance this tool, please use GitHub's
[issues](https://github.com/msztolcman/fileperms/issues).

License
-------

The MIT License (MIT)

Copyright (c) 2016 Marcin Sztolcman

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ChangeLog
---------

### v1.2.0
* added `Permissions.apply` method for applying permissions (instead
  of `os.chmod` of `path.chmod`)
* `Permissions.from_path` defines `path` as `pathlib.Path`, but *any* object with `stat` or
  `lstat` method will work ([protocols](https://docs.python.org/3/library/typing.html#typing.Protocol)
  are from Python 3.8 unfortunatelly)
* rewritten internal package configuration to from `setup.py`
  to `setup.cfg`
* improved descriptions, README etc

### v1.1.1
* fixed tests
* minor testing suite reconfig
* updates setup.py

### v1.1.0

* changed minimum Python version to 3.7+
* `os.lchmod`, `os.chmod`, `pathlib.Path.lchmod`, `pathlib.Path.chmod`
  requires explicit casting to int now :(
* changed from requirements* files to `Pipenv`
* rewrite README from .rst to .md
* cleanups

### v1.0.4

* updated README.rst

### v1.0.3

* improved documentation
* Permissions.set method now returns self

### v1.0.2

* not important

### v1.0.1

* documentation and pylint
* dev packages upgraded

### v1.0.0

* first public version