Metadata-Version: 2.1
Name: fuse-overlayfs
Version: 0.1.0
Summary: Use fuse-overlayfs to mount/unmount overlayfs in Python
Author: nukemiko
License: MIT License
        
        Copyright (c) 2024 Nukemiko<https://github.com/nukemiko>
        
        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.
        
Project-URL: Repository, https://github.com/nukemiko/python-fuse-overlayfs
Project-URL: Issues, https://github.com/nukemiko/python-fuse-overlayfs/issues
Project-URL: Changelog, https://github.com/nukemiko/python-fuse-overlayfs/blob/master/CHANGELOG.md
Keywords: overlayfs,fuse-overlayfs,fuse
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: attrs
Requires-Dist: mntfinder>=0.1.1

# Python wrapper of `fuse-overlayfs`

`fuse-overlayfs` is an implementation of overlay+shiftfs in FUSE for rootless containers, and the command name. [See this project's homepage.](https://github.com/containers/fuse-overlayfs)

## Install

Just run the command: `pip install fuse-overlayfs`.

Or you can download and install the wheel file from release page manually.

## Usage

A simple mount:

```pycon
>>> from fuseoverlayfs import FuseOverlayFS
>>> fuse_overlayfs = FuseOverlayFS.init()
>>> mnt = '/path/to/mountpoint'
>>> lowerdirs = ['/path/to/lowerdir1', '/path/to/lowerdir2']
>>> upperdir = '/path/to/upperdir'
>>> workdir = '/path/to/workdir'
>>> fuse_overlayfs.mount(mnt, lowerdirs, upperdir=upperdir, workdir=workdir)
>>>
```

A read-only mount, just remove argument `upperdir` and `workdir`:

```pycon
>>> from fuseoverlayfs import FuseOverlayFS
>>> fuse_overlayfs = FuseOverlayFS.init()
>>> mnt = '/path/to/another/mountpoint'
>>> lowerdirs = ['/path/to/lowerdir3', '/path/to/lowerdir4']
>>> fuse_overlayfs.mount(mnt, lowerdirs)
>>>
```

For more helpful information, see docstrings:

```pycon
>>> from fuseoverlayfs import FuseOverlayFS
>>> help(FuseOverlayFS.mount)
>>> help(FuseOverlayFS.unmount)
>>>
```
