Skip to content

Commit f7dc996

Browse files
committed
update documentation to PyDrive2
1 parent 74a5cd5 commit f7dc996

File tree

136 files changed

+19655
-14666
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

136 files changed

+19655
-14666
lines changed

.gitignore

-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33

44
*.egg-info
55
dist
6-
build/
76
.cache
87

98
.env
43.3 KB
Binary file not shown.

docs/build/doctrees/filelist.doctree

-569 Bytes
Binary file not shown.
-2.91 KB
Binary file not shown.

docs/build/doctrees/index.doctree

-1.03 KB
Binary file not shown.

docs/build/doctrees/oauth.doctree

-3.89 KB
Binary file not shown.

docs/build/doctrees/pydrive.doctree

-190 KB
Binary file not shown.

docs/build/doctrees/pydrive2.doctree

196 KB
Binary file not shown.
5.14 KB
Binary file not shown.

docs/build/html/.buildinfo

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config:
4-
tags:
3+
config: 5a552d8fc9e457f7bf2650fe48f2809b
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/filelist.txt renamed to docs/build/html/_sources/filelist.rst.txt

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
File listing made easy
22
=============================
33

4-
*PyDrive* handles paginations and parses response as list of `GoogleDriveFile`_.
4+
*PyDrive* handles paginations and parses response as list of `GoogleDriveFile`_.
55

66
Get all files which matches the query
77
-------------------------------------
@@ -10,7 +10,7 @@ Create `GoogleDriveFileList`_ instance with `parameters of Files.list()`_ as ``d
1010

1111
.. code-block:: python
1212
13-
from pydrive.drive import GoogleDrive
13+
from pydrive2.drive import GoogleDrive
1414
1515
drive = GoogleDrive(gauth) # Create GoogleDrive instance with authenticated GoogleAuth instance
1616
@@ -37,7 +37,7 @@ Sample code continues from above:
3737
print('title: %s, id: %s' % (file1['title'], file1['id']))
3838
3939
40-
.. _`GoogleDriveFile`: ./pydrive.html#pydrive.files.GoogleDriveFile
41-
.. _`GoogleDriveFileList`: ./pydrive.html#pydrive.files.GoogleDriveFileList
40+
.. _`GoogleDriveFile`: ./pydrive2.html#pydrive2.files.GoogleDriveFile
41+
.. _`GoogleDriveFileList`: ./pydrive2.html#pydrive2.files.GoogleDriveFileList
4242
.. _`parameters of Files.list()`: https://developers.google.com/drive/v2/reference/files/list#request
43-
.. _`GetList()`: ./pydrive.html#pydrive.apiattr.ApiResourceList.GetList
43+
.. _`GetList()`: ./pydrive2.html#pydrive2.apiattr.ApiResourceList.GetList

docs/build/html/_sources/filemanagement.txt renamed to docs/build/html/_sources/filemanagement.rst.txt

+10-10
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Here is a sample code to upload a file. ``gauth`` is an authenticated `GoogleAut
1313

1414
.. code-block:: python
1515
16-
from pydrive.drive import GoogleDrive
16+
from pydrive2.drive import GoogleDrive
1717
1818
# Create GoogleDrive instance with authenticated GoogleAuth instance.
1919
drive = GoogleDrive(gauth)
@@ -240,14 +240,14 @@ is downloaded. Just set the `remove_bom` parameter in `GetContentString()` or
240240
repository for an example.
241241

242242

243-
.. _`GoogleDriveFile`: ./pydrive.html#pydrive.files.GoogleDriveFile
244-
.. _`Upload()`: ./pydrive.html#pydrive.files.GoogleDriveFile.Upload
245-
.. _`GoogleAuth`: ./pydrive.html#pydrive.auth.GoogleAuth
246-
.. _`CreateFile()`: ./pydrive.html#pydrive.drive.GoogleDrive.CreateFile
243+
.. _`GoogleDriveFile`: ./pydrive2.html#pydrive2.files.GoogleDriveFile
244+
.. _`Upload()`: ./pydrive2.html#pydrive2.files.GoogleDriveFile.Upload
245+
.. _`GoogleAuth`: ./pydrive2.html#pydrive2.auth.GoogleAuth
246+
.. _`CreateFile()`: ./pydrive2.html#pydrive2.drive.GoogleDrive.CreateFile
247247
.. _`Files resource`: https://developers.google.com/drive/v2/reference/files#resource-representations
248-
.. _`SetContentFile(filename)`: ./pydrive.html#pydrive.files.GoogleDriveFile.SetContentFile
249-
.. _`SetContentString(content)`: ./pydrive.html#pydrive.files.GoogleDriveFile.SetContentString
250-
.. _`GetContentFile(filename)`: ./pydrive.html#pydrive.files.GoogleDriveFile.GetContentFile
251-
.. _`GetContentString()`: ./pydrive.html#pydrive.files.GoogleDriveFile.GetContentString
248+
.. _`SetContentFile(filename)`: ./pydrive2.html#pydrive2.files.GoogleDriveFile.SetContentFile
249+
.. _`SetContentString(content)`: ./pydrive2.html#pydrive2.files.GoogleDriveFile.SetContentString
250+
.. _`GetContentFile(filename)`: ./pydrive2.html#pydrive2.files.GoogleDriveFile.GetContentFile
251+
.. _`GetContentString()`: ./pydrive2.html#pydrive2.files.GoogleDriveFile.GetContentString
252252
.. _`official documentation`: https://developers.google.com/drive/v2/reference/files#resource-representations
253-
.. _`known`: https://productforums.google.com/forum/#!topic/docs/BJLimQDGtjQ
253+
.. _`known`: https://productforums.google.com/forum/#!topic/docs/BJLimQDGtjQ
+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
.. PyDrive2 documentation master file, created by
2+
sphinx-quickstart on Sun Jun 12 23:01:40 2016.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to PyDrive2's documentation!
7+
====================================
8+
9+
PyDrive2 is a wrapper library of `google-api-python-client`_ that simplifies many common Google Drive API tasks.
10+
11+
Project Info
12+
============
13+
14+
- Homepage: `https://pypi.python.org/pypi/PyDrive2 <https://pypi.python.org/pypi/PyDrive2>`_
15+
- Documentation: `Official documentation on GitHub pages <https://iterative.github.io/PyDrive2/docs/build/html/index.html>`_
16+
- Github: `https://github.com/gsuitedevs/PyDrive2 <https://github.com/iterative/PyDrive2>`_
17+
18+
How to install
19+
==============
20+
21+
You can install PyDrive2 with regular ``pip`` command.
22+
23+
::
24+
25+
$ pip install PyDrive2
26+
27+
To install the current development version from GitHub, use:
28+
29+
::
30+
31+
$ pip install git+https://github.com/iterative/PyDrive2.git#egg=PyDrive2
32+
33+
Table of Contents
34+
=================
35+
36+
.. toctree::
37+
:maxdepth: 2
38+
39+
quickstart
40+
oauth
41+
filemanagement
42+
filelist
43+
pydrive2
44+
45+
46+
.. _`google-api-python-client`: https://github.com/google/google-api-python-client
47+
48+
Indices and tables
49+
==================
50+
51+
* :ref:`genindex`
52+
* :ref:`search`
53+

docs/build/html/_sources/index.txt

-53
This file was deleted.

docs/build/html/_sources/oauth.txt renamed to docs/build/html/_sources/oauth.rst.txt

+9-8
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ Authentication in two lines
55
---------------------------
66

77
OAuth2.0 is complex and difficult to start with. To make it more simple,
8-
*PyDrive* makes all authentication into just two lines.
8+
*PyDrive2* makes all authentication into just two lines.
99

1010
.. code-block:: python
1111
12-
from pydrive.auth import GoogleAuth
12+
from pydrive2.auth import GoogleAuth
1313
1414
gauth = GoogleAuth()
1515
# Create local webserver and auto handles authentication.
@@ -32,9 +32,9 @@ authorizes by itself. You can also use `CommandLineAuth()`_ which manually
3232
takes code from user at command line.
3333

3434
.. _quickstart: ./quickstart.html#authentication
35-
.. _`LocalWebserverAuth()`: ./pydrive.html#pydrive.auth.GoogleAuth.LocalWebserverAuth
36-
.. _`GoogleAuth`: ./pydrive.html#pydrive.auth.GoogleAuth
37-
.. _`CommandLineAuth()`: ./pydrive.html#pydrive.auth.GoogleAuth.CommandLineAuth
35+
.. _`LocalWebserverAuth()`: ./pydrive2.html#pydrive2.auth.GoogleAuth.LocalWebserverAuth
36+
.. _`GoogleAuth`: ./pydrive2.html#pydrive2.auth.GoogleAuth
37+
.. _`CommandLineAuth()`: ./pydrive2.html#pydrive.auth.GoogleAuth.CommandLineAuth
3838

3939
Automatic and custom authentication with *settings.yaml*
4040
--------------------------------------------------------
@@ -115,6 +115,7 @@ ______________________
115115
oauth_scope:
116116
- https://www.googleapis.com/auth/drive.file
117117
- https://www.googleapis.com/auth/drive.install
118+
- https://www.googleapis.com/auth/drive.metadata
118119

119120
Building your own authentication flow
120121
-------------------------------------
@@ -133,12 +134,12 @@ Here is a sample code for your customized authentication flow
133134

134135
.. code-block:: python
135136
136-
from pydrive.auth import GoogleAuth
137+
from pydrive2.auth import GoogleAuth
137138
138139
gauth = GoogleAuth()
139140
auth_url = gauth.GetAuthUrl() # Create authentication url user needs to visit
140141
code = AskUserToVisitLinkAndGiveCode(auth_url) # Your customized authentication flow
141142
gauth.Auth(code) # Authorize and build service from the code
142143
143-
.. _`GetAuthUrl()`: ./pydrive.html#pydrive.auth.GoogleAuth.GetAuthUrl
144-
.. _`Auth(code)`: ./pydrive.html#pydrive.auth.GoogleAuth.Auth
144+
.. _`GetAuthUrl()`: ./pydrive2.html#pydrive2.auth.GoogleAuth.GetAuthUrl
145+
.. _`Auth(code)`: ./pydrive2.html#pydrive2.auth.GoogleAuth.Auth

docs/build/html/_sources/pydrive.txt

-42
This file was deleted.
+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
pydrive2 package
2+
================
3+
4+
pydrive2.apiattr module
5+
-----------------------
6+
7+
.. automodule:: pydrive2.apiattr
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
pydrive2.auth module
13+
--------------------
14+
15+
.. automodule:: pydrive2.auth
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
pydrive2.drive module
21+
---------------------
22+
23+
.. automodule:: pydrive2.drive
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
pydrive2.files module
29+
---------------------
30+
31+
.. automodule:: pydrive2.files
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
pydrive2.settings module
37+
------------------------
38+
39+
.. automodule:: pydrive2.settings
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:

0 commit comments

Comments
 (0)