Skip to content

Commit b97afab

Browse files
committed
readme: add fsspec
1 parent 5bccbb6 commit b97afab

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ Features of PyDrive2
3939
classes of each resource to make your program more object-oriented.
4040
- Helps common operations else than API calls, such as content fetching
4141
and pagination control.
42+
- Provides `fsspec`_ filesystem implementation.
4243

4344
How to install
4445
--------------
@@ -125,6 +126,23 @@ File listing pagination made easy
125126
for file1 in file_list:
126127
print('title: {}, id: {}'.format(file1['title'], file1['id']))
127128
129+
Fsspec filesystem
130+
-----------------
131+
132+
*PyDrive2* provides easy way to work with your files through `fsspec`_
133+
compatible `GDriveFileSystem`_.
134+
135+
.. code:: python
136+
137+
from pydrive2.fs import GDriveFileSystem
138+
139+
fs = GDriveFileSystem("root", client_id=my_id, client_secret=my_secret)
140+
141+
for root, dnames, fnames in fs.walk("."):
142+
...
143+
144+
.. _`GDriveFileSystem`: https://docs.iterative.ai/PyDrive2/fsspec/
145+
128146
Concurrent access made easy
129147
---------------------------
130148

@@ -137,3 +155,5 @@ Thanks to all our contributors!
137155

138156
.. image:: https://contrib.rocks/image?repo=iterative/PyDrive2
139157
:target: https://github.com/iterative/PyDrive2/graphs/contributors
158+
159+
.. _`fsspec`: https://filesystem-spec.readthedocs.io/en/latest/

0 commit comments

Comments
 (0)