Update to version 1.3.0, updates to BOM handling, Encoding specificat…

…ion, Documentation (including new examples folder), and .gitignore. Add BOM removal ability, update .gitignore. BOM removal implemented, new test passing. Added internal flag, fixed test. Implemented RemovePrefix, tests added and passing. BOM {insert | remove} tests now passing. Refactor of RemoveBOM for readability. Integration tests now passing. Documentation updated, example added, .gitignore updated. Added TODO file. Add optional parameter to {Get|Set}ContentString to choose encoding, resolves #74, add example of folder use, resolves #72. Correct the quickstart documentation. Add CONTRIBUTING. Update CommandLineAuth documentation. Bump the version. Update documentation, and remove superfluous make files.
googlearchive · Sep 4, 2016 · 986ad8f · 986ad8f
1 parent c2f56b8
commit 986ad8f
Show file tree

Hide file tree

Showing 93 changed files with 575 additions and 1,984 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,7 @@ pydrive/test/credentials/*
 
 *.egg-info
 dist
+build/
+.cache
+
+client_secrets.json
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -0,0 +1,27 @@
+Contributing guidelines
+=======================
+
+How to become a contributor and submit your own code
+----------------------------------------------------
+
+Contributor License Agreements
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+We'd love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles.
+
+Please fill out either the individual or corporate Contributor License Agreement (CLA).
+
+* If you are an individual writing original source code and you're sure you
+  own the intellectual property, then you'll need to sign an `individual CLA <http://code.google.com/legal/individual-cla-v1.0.html>`_.
+* If you work for a company that wants to allow you to contribute your
+  work, then you'll need to sign a `corporate CLA <http://code.google.com/legal/corporate-cla-v1.0.html>`_.
+
+Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.
+
+***NOTE***: Only original source code from you and other people that have signed the CLA can be accepted into the main repository.
+
+Contributing code
+~~~~~~~~~~~~~~~~~
+
+If you have improvements to PyDrive, send us your pull requests! For those
+just getting started, Github has a `howto <https://help.github.com/articles/using-pull-requests/>`_.
diff --git a/README.rst b/README.rst
@@ -8,8 +8,8 @@ that simplifies many common Google Drive API tasks.
 Project Info
 ------------
 
-- Homepage: `https://pypi.python.org/pypi/PyDrive <https://pypi.python.org/pypi/PyDrive>`_                                                 
-- Documentation: `Official documentation on GitHub pages <https://googledrive.github.io/PyDrive/docs/_build/html/index.html>`_
+- Homepage: `https://pypi.python.org/pypi/PyDrive <https://pypi.python.org/pypi/PyDrive>`_
+- Documentation: `Official documentation on GitHub pages <https://googledrive.github.io/PyDrive/docs/build/html/index.html>`_
 - Github: `https://github.com/googledrive/PyDrive <https://github.com/googledrive/PyDrive>`_
 
 Features of PyDrive
@@ -48,15 +48,15 @@ file *settings.yaml*.
 
     from pydrive.auth import GoogleAuth
     from pydrive.drive import GoogleDrive
-    
+
     gauth = GoogleAuth()
     gauth.LocalWebserverAuth()
-    
+
     drive = GoogleDrive(gauth)
 
 File management made easy
 -------------------------
-    
+
 Upload/update the file with one method. PyDrive will do it in the most
 efficient way.
 

diff --git a/TODO b/TODO
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/README b/docs/README
@@ -1,8 +1,9 @@
 This document outlines how to rebuild the documentation.
 
 General setup:
-- Install Sphinx, `pip install sphinx`
-- run `make html` in this folder, to update the documentation.
+- Install Sphinx, `pip install sphinx` or `apt-get install python-sphinx`
+- Install the theme used for the docs: `pip install sphinx_rtd_theme`
+- Run `python setup.py build_sphinx --source-dir=docs/ --build-dir=docs/build --all-files`
 
 If code files were added, the easiest way to reflect code changes in the
 documentation by referencing the file from within pydrive.rst.

diff --git a/docs/_build/doctrees/filemanagement.doctree b/docs/_build/doctrees/filemanagement.doctree
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/modules.doctree b/docs/_build/doctrees/modules.doctree
diff --git a/docs/_build/doctrees/pydrive.doctree b/docs/_build/doctrees/pydrive.doctree
diff --git a/docs/_build/doctrees/pydrive.test.doctree b/docs/_build/doctrees/pydrive.test.doctree
diff --git a/docs/_build/doctrees/setup.doctree b/docs/_build/doctrees/setup.doctree
diff --git a/docs/_build/html/_sources/modules.txt b/docs/_build/html/_sources/modules.txt
diff --git a/docs/_build/html/_sources/pydrive.test.txt b/docs/_build/html/_sources/pydrive.test.txt
diff --git a/docs/_build/html/_sources/setup.txt b/docs/_build/html/_sources/setup.txt