| Name | fuse-overlayfs JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | |
| Summary | Use fuse-overlayfs to mount/unmount overlayfs in Python |
| upload_time | 2024-01-08 05:10:06 |
| maintainer | |
| docs_url | None |
| author | nukemiko |
| requires_python | >=3.10 |
| 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. |
| keywords |
overlayfs
fuse-overlayfs
fuse
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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)
>>>
```
Raw data
{
"_id": null,
"home_page": "",
"name": "fuse-overlayfs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "overlayfs,fuse-overlayfs,fuse",
"author": "nukemiko",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/29/4e/137d959c51c1cd88eb6eb3561827f67280b6261e4f7659b38a515c39601b/fuse-overlayfs-0.1.0.tar.gz",
"platform": null,
"description": "# Python wrapper of `fuse-overlayfs`\n\n`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)\n\n## Install\n\nJust run the command: `pip install fuse-overlayfs`.\n\nOr you can download and install the wheel file from release page manually.\n\n## Usage\n\nA simple mount:\n\n```pycon\n>>> from fuseoverlayfs import FuseOverlayFS\n>>> fuse_overlayfs = FuseOverlayFS.init()\n>>> mnt = '/path/to/mountpoint'\n>>> lowerdirs = ['/path/to/lowerdir1', '/path/to/lowerdir2']\n>>> upperdir = '/path/to/upperdir'\n>>> workdir = '/path/to/workdir'\n>>> fuse_overlayfs.mount(mnt, lowerdirs, upperdir=upperdir, workdir=workdir)\n>>>\n```\n\nA read-only mount, just remove argument `upperdir` and `workdir`:\n\n```pycon\n>>> from fuseoverlayfs import FuseOverlayFS\n>>> fuse_overlayfs = FuseOverlayFS.init()\n>>> mnt = '/path/to/another/mountpoint'\n>>> lowerdirs = ['/path/to/lowerdir3', '/path/to/lowerdir4']\n>>> fuse_overlayfs.mount(mnt, lowerdirs)\n>>>\n```\n\nFor more helpful information, see docstrings:\n\n```pycon\n>>> from fuseoverlayfs import FuseOverlayFS\n>>> help(FuseOverlayFS.mount)\n>>> help(FuseOverlayFS.unmount)\n>>>\n```\n",
"bugtrack_url": null,
"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. ",
"summary": "Use fuse-overlayfs to mount/unmount overlayfs in Python",
"version": "0.1.0",
"project_urls": {
"Changelog": "https://github.com/nukemiko/python-fuse-overlayfs/blob/master/CHANGELOG.md",
"Issues": "https://github.com/nukemiko/python-fuse-overlayfs/issues",
"Repository": "https://github.com/nukemiko/python-fuse-overlayfs"
},
"split_keywords": [
"overlayfs",
"fuse-overlayfs",
"fuse"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "23fb21372ee1d295995449d288938afbc746e7d63fb11609b64b7f96cbd03dd8",
"md5": "580b4dbcef904b3753f3f59f7efabeb5",
"sha256": "80a897e4c750bf53ce2031bf5ba2c19f36da03c5f6189efc0788a91b29700b4e"
},
"downloads": -1,
"filename": "fuse_overlayfs-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "580b4dbcef904b3753f3f59f7efabeb5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 6227,
"upload_time": "2024-01-08T05:10:03",
"upload_time_iso_8601": "2024-01-08T05:10:03.598910Z",
"url": "https://files.pythonhosted.org/packages/23/fb/21372ee1d295995449d288938afbc746e7d63fb11609b64b7f96cbd03dd8/fuse_overlayfs-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "294e137d959c51c1cd88eb6eb3561827f67280b6261e4f7659b38a515c39601b",
"md5": "1fa1286de1376016bd7ed2d2cec8ef19",
"sha256": "928b7e5d2eb617350913842a9a7efd2d435217767e36a9c7aeb371fcf0a686a6"
},
"downloads": -1,
"filename": "fuse-overlayfs-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1fa1286de1376016bd7ed2d2cec8ef19",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 5546,
"upload_time": "2024-01-08T05:10:06",
"upload_time_iso_8601": "2024-01-08T05:10:06.008596Z",
"url": "https://files.pythonhosted.org/packages/29/4e/137d959c51c1cd88eb6eb3561827f67280b6261e4f7659b38a515c39601b/fuse-overlayfs-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-08 05:10:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nukemiko",
"github_project": "python-fuse-overlayfs",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "fuse-overlayfs"
}
