Skip to content

Commit dec3982

Browse files
committed
[doc] Update ReadMe
1 parent 7723553 commit dec3982

File tree

2 files changed

+38
-4
lines changed

2 files changed

+38
-4
lines changed

README

Lines changed: 0 additions & 1 deletion
This file was deleted.

README.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# mfusepy
22

3+
[![Python Version](https://img.shields.io/pypi/pyversions/mfusepy)](https://pypi.org/project/mfusepy/)
4+
[![PyPI version](https://badge.fury.io/py/mfusepy.svg)](https://badge.fury.io/py/mfusepy)
5+
[![Downloads](https://static.pepy.tech/badge/mfusepy/month)](https://pepy.tech/project/mfusepy)
6+
[![Changelog](https://img.shields.io/badge/Changelog-Markdown-blue)](https://github.com/mxmlnkn/mfusepy/blob/master/CHANGELOG.md)
7+
[![License](https://img.shields.io/badge/license-ISC-blue.svg)](http://opensource.org/licenses/ISC)
8+
[![Build Status](https://github.com/mxmlnkn/mfusepy/actions/workflows/tests.yml/badge.svg)](https://github.com/mxmlnkn/mfusepy/actions)
9+
[![Discord](https://img.shields.io/discord/783411320354766878?label=discord)](https://discord.gg/Wra6t6akh2)
10+
[![Telegram](https://img.shields.io/badge/Chat-Telegram-%2330A3E6)](https://t.me/joinchat/FUdXxkXIv6c4Ib8bgaSxNg)
11+
312
`mfusepy` is a Python module that provides a simple interface to [FUSE](https://docs.kernel.org/filesystems/fuse.html) and [macFUSE](https://osxfuse.github.io/).
413
It's just one file and is implemented using ctypes to use [libfuse](https://github.com/libfuse/libfuse).
514

@@ -15,6 +24,23 @@ pip install mfusepy
1524
You also need to install the `fuse` (2) or [`fuse3`](https://pkgs.org/search/?q=fuse3) package on your system.
1625

1726

27+
# Versioning
28+
29+
This version tries to follow [semantic versioning](https://semver.org/).
30+
If you depend on this project, you should fix the major version, or else you risk your project breaking on a newer version release!
31+
E.g., in your pyproject.toml:
32+
33+
```toml
34+
dependencies = ["mfusepy ~= 1.1",]
35+
```
36+
37+
If you have tested with multiple major versions and they are known to work, you can also relax the check for maximum compatibility:
38+
39+
```toml
40+
dependencies = ["mfusepy >= 1.1, < 3.0",]
41+
```
42+
43+
1844
# About this fork
1945

2046
This is a fork of [fusepy](https://github.com/fusepy/fusepy) because it did not see any development for over 6 years.
@@ -42,7 +68,7 @@ The prefix `m` in the name stands for anything you want it to: "multi" because m
4268
| [refuse](https://github.com/pleiszenburg/refuse) | ISC | [3](https://www.wheelodex.org/projects/refuse/rdepends/) | Dead fork of fusepy with many other dead forks: [[1]](https://github.com/yarikoptic/refuse) [[2]](https://github.com/YoilyL/refuse) |
4369
| [fusepyng](https://pypi.org/project/fusepyng/) | ISC | [0](https://www.wheelodex.org/projects/fusepyng/rdepends/) | Dead fork of fusepy. Github repo has been force-pushed as a statement. Fork [here](https://github.com/djsutherland/fusepyng). |
4470
| [userspacefs](https://pypi.org/project/userspacefs/) | GPL3 (why not ISC?) | [1](https://www.wheelodex.org/projects/userspacefs/rdepends/) | Fork of fusepyng/fusepy. Gated behind self-hosting solution with no possibility to open issues or pull requests. |
45-
| [fusepy3](https://github.com/fox-it/fusepy3) | ISC | Not on PyPI | Fork of fusepy for [fox-it/dissect](https://github.com/fox-it/dissect) ecosystem to add libfuse3 support. Seems to drop libfuse2 support though and I it does not seem to work around the ABI [incompatibilities](https://github.com/libfuse/libfuse/issues/1029) between libfuse3 minor versions. Last update 9 months ago. Looks like publish and forget, or it may simply have no bugs. |
71+
| [fusepy3](https://github.com/fox-it/fusepy3) | ISC | Not on PyPI | Fork of fusepy for [fox-it/dissect](https://github.com/fox-it/dissect) ecosystem to add libfuse3 support. Seems to drop libfuse2 support though and it does not seem to work around the ABI [incompatibilities](https://github.com/libfuse/libfuse/issues/1029) between libfuse3 minor versions. Last update 1.5 years ago. Looks like publish and forget, or it may simply have no bugs. |
4672

4773

4874
## Low-level interface support (inode/int-based)
@@ -52,8 +78,8 @@ In the end, there is mostly only some path-to-hash table in the high-level libfu
5278

5379
| Project | License | Dependants | Notes
5480
|------------------------------------------------------------------|------|-----|------------------------|
55-
| [pyfuse3](https://github.com/libfuse/pyfuse3) | LGPL | [9](https://www.wheelodex.org/projects/pyfuse3/rdepends/) | ReadMe contains: "Warning - no longer developed!" |
56-
| [llfuse](https://github.com/python-llfuse/python-llfuse/) | LGPL | [2](https://www.wheelodex.org/projects/llfuse/rdepends/) | ReadMe contains: ["Warning - no longer developed!"](https://github.com/python-llfuse/python-llfuse/issues/67), but last release was 2 months ago. |
81+
| [pyfuse3](https://github.com/libfuse/pyfuse3) | LGPL | [9](https://www.wheelodex.org/projects/pyfuse3/rdepends/) | ReadMe contains: "Warning - no longer developed!", and last release was 11 months ago. |
82+
| [llfuse](https://github.com/python-llfuse/python-llfuse/) | LGPL | [2](https://www.wheelodex.org/projects/llfuse/rdepends/) | ReadMe contains: ["Warning - no longer developed!"](https://github.com/python-llfuse/python-llfuse/issues/67), and last release was 11 months ago. |
5783
| [arvados-llfuse](https://github.com/arvados/python-llfuse/) | LGPL | [1](https://www.wheelodex.org/projects/arvados-llfuse/rdepends/) | Fork of llfuse, but less up to date? |
5884
| [aliyundrive-fuse](https://github.com/messense/aliyundrive-fuse) | MIT | [0](https://www.wheelodex.org/projects/aliyundrive-fuse/rdepends/) | Alibaba Cloud Disk FUSE disk mount "This repository has been archived by the owner on Mar 28, 2023". Only Chinese documentation. Only read support. Multiple fizzled out forks: [pikpak-fuse](https://github.com/ykxVK8yL5L/pikpak-fuse/), [alist-fuse](https://github.com/ykxVK8yL5L/alist-fuse) |
5985

@@ -86,6 +112,15 @@ While FUSE is (at least in the Unix world) a [Kernel feature](https://man7.org/l
86112
- [librefuse](https://github.com/NetBSD/src/tree/netbsd-8/lib/librefuse) (NetBSD) through [PUFFS](https://en.wikipedia.org/wiki/PUFFS_(NetBSD)) (fuse.h [2](https://github.com/NetBSD/src/blob/netbsd-8/lib/librefuse/fuse.h))
87113
- [FUSE for macOS](https://github.com/osxfuse/osxfuse) (OSX) (fuse.h [2](https://github.com/osxfuse/fuse/blob/master/include/fuse.h))
88114
- [MacFUSE](https://code.google.com/archive/p/macfuse/) (OSX), no longer maintained
115+
- [MacFUSE](https://macfuse.github.io/) (OSX), [Github](https://github.com/macfuse/library)
116+
- [FUSE-T](https://www.fuse-t.org/) (OSX), [Github](https://github.com/macos-fuse-t/fuse-t)
89117
- [WinFsp](https://github.com/billziss-gh/winfsp) (Windows) (fuse.h [2](https://github.com/winfsp/winfsp/blob/master/inc/fuse/fuse.h) [3](https://github.com/winfsp/winfsp/blob/master/inc/fuse3/fuse.h))
90118
- [Dokany](https://github.com/dokan-dev/dokany) (Windows) (fuse.h [2](https://github.com/dokan-dev/dokany/blob/master/dokan_fuse/include/fuse.h))
91119
- [Dokan](https://code.google.com/archive/p/dokan/) (Windows), no longer maintained
120+
121+
122+
# Known Dependants
123+
124+
- [Megatron-Energon](https://github.com/NVIDIA/Megatron-Energon)
125+
- [ninfs](https://github.com/ihaveamac/ninfs)
126+
- [ratarmount](https://github.com/mxmlnkn/ratarmount)

0 commit comments

Comments
 (0)