Skip to content

Commit dbed2ec

Browse files
Add more "Other Known Implementations" (#1721)
Co-authored-by: Martin Durant <[email protected]>
1 parent 4cb98ab commit dbed2ec

File tree

1 file changed

+42
-12
lines changed

1 file changed

+42
-12
lines changed

docs/source/api.rst

Lines changed: 42 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -209,43 +209,73 @@ Built-in Implementations
209209
Other Known Implementations
210210
---------------------------
211211

212-
- `abfs`_ for Azure Blob service
213-
- `adl`_ for Azure DataLake storage
212+
213+
Note that most of these projects are hosted outside of the `fsspec` organisation. Please read their
214+
documentation carefully before using any particular package.
215+
216+
- `abfs`_ for Azure Blob service, with protocol "abfs://"
217+
- `adl`_ for Azure DataLake storage, with protocol "adl://"
214218
- `alluxiofs`_ to access fsspec implemented filesystem with Alluxio distributed cache
215-
- `boxfs`_ for access to Box file storage
216-
- `dropbox`_ for access to dropbox shares
219+
- `boxfs`_ for access to Box file storage, with protocol "box://"
220+
- `csvbase`_ for access to csvbase.com hosted CSV files, with protocol "csvbase://"
221+
- `dropbox`_ for access to dropbox shares, with protocol "dropbox://"
217222
- `dvc`_ to access DVC/Git repository as a filesystem
218-
- `gcsfs`_ for Google Cloud Storage
223+
- `fsspec-encrypted`_ for transparent encryption on top of other fsspec filesystems.
224+
- `gcsfs`_ for Google Cloud Storage, with protocol "gcs://"
219225
- `gdrive`_ to access Google Drive and shares (experimental)
226+
- `git`_ to access Git repositories
220227
- `huggingface_hub`_ to access the Hugging Face Hub filesystem, with protocol "hf://"
221-
- `lakefs`_ for lakeFS data lakes
222-
- `ocifs`_ for access to Oracle Cloud Object Storage
228+
- `hdfs-native`_ to access Hadoop filesystem, with protocol "hdfs://"
229+
- `httpfs-sync`_ to access HTTP(s) files in a synchronous manner to offer an alternative to the aiohttp-based implementation.
230+
- `ipfsspec`_ for the InterPlanetary File System (IPFS), with protocol "ipfs://"
231+
- `irods`_ for access to iRODS servers, with protocol "irods://"
232+
- `lakefs`_ for lakeFS data lakes, with protocol "lakefs://"
233+
- `morefs`_ for `OverlayFileSystem`, `DictFileSystem`, and others
234+
- `ocifs`_ for access to Oracle Cloud Object Storage, with protocol "oci://"
223235
- `ocilake`_ for OCI Data Lake storage
224236
- `ossfs`_ for Alibaba Cloud (Aliyun) Object Storage System (OSS)
225237
- `p9fs`_ for 9P (Plan 9 Filesystem Protocol) servers
226-
- `s3fs`_ for Amazon S3 and other compatible stores
238+
- `PyAthena`_ for S3 access to Amazon Athena, with protocol "s3://" or "s3a://"
239+
- `PyDrive2`_ for Google Drive access
240+
- `s3fs`_ for Amazon S3 and other compatible stores, with protocol "s3://"
241+
- `sshfs`_ for access to SSH servers, with protocol "ssh://" or "sftp://"
242+
- `swiftspec`_ for OpenStack SWIFT, with protocol "swift://"
227243
- `tosfs`_ for ByteDance volcano engine Tinder Object Storage (TOS)
228244
- `wandbfs`_ to access Wandb run data (experimental)
229-
- `webdav4`_ for WebDAV
245+
- `wandbfsspec`_ to access Weights & Biases (experimental)
246+
- `webdav4`_ for WebDAV, with protocol "webdav://" or "dav://"
230247
- `xrootd`_ for xrootd, with protocol "root://"
231248

232249
.. _abfs: https://github.com/dask/adlfs
233250
.. _adl: https://github.com/dask/adlfs
234251
.. _alluxiofs: https://github.com/fsspec/alluxiofs
235252
.. _boxfs: https://github.com/IBM/boxfs
236-
.. _dropbox: https://github.com/MarineChap/intake_dropbox
253+
.. _csvbase: https://github.com/calpaterson/csvbase-client
254+
.. _dropbox: https://github.com/fsspec/dropboxdrivefs
237255
.. _dvc: https://github.com/iterative/dvc
256+
.. _fsspec-encrypted: https://github.com/thevgergroup/fsspec-encrypted
238257
.. _gcsfs: https://gcsfs.readthedocs.io/en/latest/
239258
.. _gdrive: https://github.com/fsspec/gdrivefs
259+
.. _git: https://github.com/iterative/scmrepo
260+
.. _hdfs-native: https://github.com/Kimahriman/hdfs-native/blob/master/python/hdfs_native/fsspec.py
261+
.. _httpfs-sync: https://github.com/moradology/httpfs-sync
240262
.. _huggingface_hub: https://huggingface.co/docs/huggingface_hub/main/en/guides/hf_file_system
241-
.. _lakefs: https://github.com/appliedAI-Initiative/lakefs-spec
242-
.. _ocifs: https://pypi.org/project/ocifs
263+
.. _ipfsspec: https://github.com/fsspec/ipfsspec
264+
.. _irods: https://github.com/xwcl/irods_fsspec
265+
.. _lakefs: https://github.com/aai-institute/lakefs-spec
266+
.. _morefs: https://github.com/iterative/morefs
267+
.. _ocifs: https://ocifs.readthedocs.io/en/latest/
243268
.. _ocilake: https://github.com/oracle/ocifs
244269
.. _ossfs: https://github.com/fsspec/ossfs
245270
.. _p9fs: https://github.com/pbchekin/p9fs-py
271+
.. _PyAthena: https://github.com/laughingman7743/PyAthena
272+
.. _PyDrive2: https://github.com/iterative/PyDrive2
246273
.. _s3fs: https://s3fs.readthedocs.io/en/latest/
274+
.. _sshfs: https://github.com/fsspec/sshfs
275+
.. _swiftspec: https://github.com/fsspec/swiftspec
247276
.. _tosfs: https://tosfs.readthedocs.io/en/latest/
248277
.. _wandbfs: https://github.com/jkulhanek/wandbfs
278+
.. _wandbfsspec: https://github.com/alvarobartt/wandbfsspec
249279
.. _webdav4: https://github.com/skshetry/webdav4
250280
.. _xrootd: https://github.com/CoffeaTeam/fsspec-xrootd
251281

0 commit comments

Comments
 (0)