shoogle-0.1.4/0000755000000000000000000000000012747455150013124 5ustar rootroot00000000000000shoogle-0.1.4/shoogle.egg-info/0000755000000000000000000000000012747455150016256 5ustar rootroot00000000000000shoogle-0.1.4/shoogle.egg-info/top_level.txt0000644000000000000000000000004612747455147021016 0ustar rootroot00000000000000shoogle shoogle/auth shoogle/commands shoogle-0.1.4/shoogle.egg-info/SOURCES.txt0000644000000000000000000000144312747455147020152 0ustar rootroot00000000000000CHANGELOG.md LICENSE MANIFEST.in README.md setup.cfg setup.py bin/shoogle docs/Makefile docs/authors.rst docs/conf.py docs/contributing.rst docs/history.rst docs/index.rst docs/installation.rst docs/make.bat docs/readme.rst docs/usage.rst shoogle/__init__.py shoogle/a.py shoogle/common.py shoogle/config.py shoogle/lib.py shoogle/shoogle.py shoogle.egg-info/PKG-INFO shoogle.egg-info/SOURCES.txt shoogle.egg-info/dependency_links.txt shoogle.egg-info/not-zip-safe shoogle.egg-info/requires.txt shoogle.egg-info/top_level.txt shoogle/auth/__init__.py shoogle/auth/auth.py shoogle/auth/browser.py shoogle/auth/console.py shoogle/commands/__init__.py shoogle/commands/execute.py shoogle/commands/show.py tests/__init__.py tests/secrets.json tests/secrets.py tests/secrets.py.template tests/test_shoogle.pyshoogle-0.1.4/shoogle.egg-info/not-zip-safe0000644000000000000000000000000112747455107020506 0ustar rootroot00000000000000 shoogle-0.1.4/shoogle.egg-info/dependency_links.txt0000644000000000000000000000000112747455147022332 0ustar rootroot00000000000000 shoogle-0.1.4/shoogle.egg-info/requires.txt0000644000000000000000000000005012747455147020657 0ustar rootroot00000000000000google-api-python-client jsmin httplib2 shoogle-0.1.4/shoogle.egg-info/PKG-INFO0000644000000000000000000001526112747455147017366 0ustar rootroot00000000000000Metadata-Version: 1.1 Name: shoogle Version: 0.1.4 Summary: Google API from the command line Home-page: https://github.com/tokland/shoogle Author: Arnau Sanchez Author-email: pyarnau@gmail.com License: ISCL Description: Shoogle ======= Use the Google API from the shell. An example, get the long URL using the *urlshortener* service: :: $ echo '{"shortUrl": "http://goo.gl/Du5PSN"}' | shoogle execute urlshortener:v1.url.get - { "status": "OK", "id": "http://goo.gl/Du5PSN", "longUrl": "http://1.bp.blogspot.com/-R0HSXDqlJI8/Tr67i-kr7hI/AAAAAAABMko/gaId6iYuhjA/s1600/12_%252520Cross%252520that%252520bridge%252520when%252520we%252520come%252520to%252520it.jpg", "kind": "urlshortener#url" } Install ------- Dependencies ~~~~~~~~~~~~ - Python >= 3.0 From PyPi ~~~~~~~~~ :: $ sudo pip install shoogle From sources ~~~~~~~~~~~~ :: $ wget https://github.com/tokland/shoogle/archive/master.zip $ unzip master.zip $ cd shoogle-master $ sudo pip install pypandoc $ sudo python setup.py install Features -------- - Exposes agnostically all the services in the API. - Provides infrastructure for the Oauth2 authentication (console or QT/GTK browser). - Shows information from the Google Discovery API to help build the JSON requests. - Save credentials for each set of scopes. Setup: configure the API and secret keys ---------------------------------------- - You must enable the services you want to use and create the required keys or secret file in the `API Manager `_. Each service has its own policies, check the Google documentation for more details. Commands -------- show ~~~~ Incrementally show details of services/resources/methods: :: $ shoogle show adexchangebuyer2:v2beta1 - Ad Exchange Buyer API II adexchangebuyer:v1.2 - Ad Exchange Buyer API ... youtubeAnalytics:v1beta1 - YouTube Analytics API youtubereporting:v1 - YouTube Reporting API :: $ shoogle show short urlshortener:v1 - URL Shortener API :: $ shoogle show urlshortener:v1 urlshortener:v1.url :: $ shoogle show urlshortener:v1.url urlshortener:v1.url.get - Expands a short URL or gets creation time and analytics. urlshortener:v1.url.insert - Creates a new short URL. urlshortener:v1.url.list - Retrieves a list of URLs shortened by a user. :: $ shoogle show urlshortener:v1.url.get [INFO] Response (level=0, --debug-response-level=N to change): { "$ref": "Url" } [INFO] Request (level=1, --debug-request-level=N to change): { "shortUrl": "(string) The short URL, including the protocol - required" } execute ~~~~~~~ - Expand a short URL: :: $ cat get-longurl.json { "key": "YOUR_SECRET_KEY", // You can use JS comments! "shortUrl": "http://goo.gl/Du5PSN" } $ shoogle execute urlshortener:v1.url.get get-longurl.json { "status": "OK", "id": "http://goo.gl/Du5PSN", "longUrl": "http://1.bp.blogspot.com/-R0HSXDqlJI8/Tr67i-kr7hI/AAAAAAABMko/gaId6iYuhjA/s1600/12_%252520Cross%252520that%252520bridge%252520when%252520we%252520come%252520to%252520it.jpg", "kind": "urlshortener#url" } - `jq `_ is a command-line JSON builder/parser. This example shows how to upload a video from a JSON template and extract the ID from the response: :: $ cat upload-video.template.json { "part": "snippet", "body": { "snippet": { "title": $title, "description": $description } } } :: $ jq -n -f upload-video.template.json --arg title "Chess" --arg description "Norway Chess" | shoogle execute -c your_client_id.json youtube:v3.videos.insert - -f chess.mp4 | jq -r '.id' wUArz2nPGqA More ---- - License: `GNU/GPLv3 `_. Feedback -------- - Issues: Please open issues only to report bugs of the package. If you have problems regarding how to use the API itself (what auth is required, how to create those auth files, how to build the request parameters, quotas management, etc), use the `Google Forums `_ or `StackOverflow `_. - `Want to donate? `_ ChangeLog ========= [0.1.0] ------- - Provides infrastructure for Oauth2 authentication (console and browser). - Exposes all services supported by the Python Gooogle API. Keywords: shoogle Platform: UNKNOWN Classifier: Development Status :: 4 - Beta Classifier: Intended Audience :: End Users/Desktop Classifier: License :: OSI Approved :: GNU General Public License (GPL) Classifier: Natural Language :: English Classifier: Operating System :: POSIX Classifier: Operating System :: Microsoft :: Windows Classifier: Topic :: Internet :: WWW/HTTP Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.3 Classifier: Programming Language :: Python :: 3.4 Classifier: Programming Language :: Python :: 3.5 shoogle-0.1.4/README.md0000644000175000017500000000776212735755652014726 0ustar arnauarnau00000000000000# Shoogle Use the Google API from the shell. An example, get the long URL using the *urlshortener* service: ```shell $ echo '{"shortUrl": "http://goo.gl/Du5PSN"}' | shoogle execute urlshortener:v1.url.get - { "status": "OK", "id": "http://goo.gl/Du5PSN", "longUrl": "http://1.bp.blogspot.com/-R0HSXDqlJI8/Tr67i-kr7hI/AAAAAAABMko/gaId6iYuhjA/s1600/12_%252520Cross%252520that%252520bridge%252520when%252520we%252520come%252520to%252520it.jpg", "kind": "urlshortener#url" } ``` ## Install ### Dependencies * Python >= 3.0 ### From PyPi ```shell $ sudo pip install shoogle ``` ### From sources ```shell $ wget https://github.com/tokland/shoogle/archive/master.zip $ unzip master.zip $ cd shoogle-master $ sudo pip install pypandoc $ sudo python setup.py install ``` ## Features * Exposes agnostically all the services in the API. * Provides infrastructure for the Oauth2 authentication (console or QT/GTK browser). * Shows information from the Google Discovery API to help build the JSON requests. * Save credentials for each set of scopes. ## Setup: configure the API and secret keys * You must enable the services you want to use and create the required keys or secret file in the [API Manager](https://console.developers.google.com/apis/). Each service has its own policies, check the Google documentation for more details. ## Commands ### show Incrementally show details of services/resources/methods: ```shell $ shoogle show adexchangebuyer2:v2beta1 - Ad Exchange Buyer API II adexchangebuyer:v1.2 - Ad Exchange Buyer API ... youtubeAnalytics:v1beta1 - YouTube Analytics API youtubereporting:v1 - YouTube Reporting API ``` ```shell $ shoogle show short urlshortener:v1 - URL Shortener API ``` ```shell $ shoogle show urlshortener:v1 urlshortener:v1.url ``` ```shell $ shoogle show urlshortener:v1.url urlshortener:v1.url.get - Expands a short URL or gets creation time and analytics. urlshortener:v1.url.insert - Creates a new short URL. urlshortener:v1.url.list - Retrieves a list of URLs shortened by a user. ``` ```shell $ shoogle show urlshortener:v1.url.get [INFO] Response (level=0, --debug-response-level=N to change): { "$ref": "Url" } [INFO] Request (level=1, --debug-request-level=N to change): { "shortUrl": "(string) The short URL, including the protocol - required" } ``` ### execute * Expand a short URL: ```shell $ cat get-longurl.json { "key": "YOUR_SECRET_KEY", // You can use JS comments! "shortUrl": "http://goo.gl/Du5PSN" } $ shoogle execute urlshortener:v1.url.get get-longurl.json { "status": "OK", "id": "http://goo.gl/Du5PSN", "longUrl": "http://1.bp.blogspot.com/-R0HSXDqlJI8/Tr67i-kr7hI/AAAAAAABMko/gaId6iYuhjA/s1600/12_%252520Cross%252520that%252520bridge%252520when%252520we%252520come%252520to%252520it.jpg", "kind": "urlshortener#url" } ``` * [jq](https://stedolan.github.io/jq/) is a command-line JSON builder/parser. This example shows how to upload a video from a JSON template and extract the ID from the response: ```shell $ cat upload-video.template.json { "part": "snippet", "body": { "snippet": { "title": $title, "description": $description } } } ``` ```shell $ jq -n -f upload-video.template.json --arg title "Chess" --arg description "Norway Chess" | shoogle execute -c your_client_id.json youtube:v3.videos.insert - -f chess.mp4 | jq -r '.id' wUArz2nPGqA ``` ## More * License: [GNU/GPLv3](http://www.gnu.org/licenses/gpl.html). ## Feedback * Issues: Please open issues only to report bugs of the package. If you have problems regarding how to use the API itself (what auth is required, how to create those auth files, how to build the request parameters, quotas management, etc), use the [Google Forums](https://developers.google.com/groups/) or [StackOverflow](http://stackoverflow.com/questions/tagged/google-api). * [Want to donate?](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=pyarnau%40gmail%2ecom&lc=US&item_name=youtube%2dupload&no_note=0¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHostedGuest) shoogle-0.1.4/setup.py0000755000175000017500000000310412747455147015145 0ustar arnauarnau00000000000000#!/usr/bin/env python try: import pypandoc except ImportError: print("Install pypandoc to generate the field long_description") pypandoc = None from setuptools import setup if pypandoc: long_description = "\n\n".join([ pypandoc.convert('README.md', 'rst'), pypandoc.convert('CHANGELOG.md', 'rst'), ]) else: long_description = "[pypandoc missing]" setup( name='shoogle', version='0.1.4', description="Google API from the command line", long_description=long_description, author="Arnau Sanchez", author_email='pyarnau@gmail.com', url='https://github.com/tokland/shoogle', packages=[ 'shoogle', "shoogle/auth", "shoogle/commands", ], package_dir={'shoogle': 'shoogle'}, scripts=["bin/shoogle"], include_package_data=True, install_requires=[ "google-api-python-client", "jsmin", "httplib2", ], license="ISCL", zip_safe=False, keywords='shoogle', classifiers=[ 'Development Status :: 4 - Beta', 'Intended Audience :: End Users/Desktop', 'License :: OSI Approved :: GNU General Public License (GPL)', 'Natural Language :: English', 'Operating System :: POSIX', 'Operating System :: Microsoft :: Windows', 'Topic :: Internet :: WWW/HTTP', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.3', 'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.5', ], test_suite='tests', tests_require=[], ) shoogle-0.1.4/tests/0000755000000000000000000000000012747455150014266 5ustar rootroot00000000000000shoogle-0.1.4/tests/secrets.py0000644000175000017500000000015212714453053016600 0ustar arnauarnau00000000000000"""Secret data for Google API to test Shoogle.""" server_key = "AIzaSyAknezZrIduryQGPecGwjPVXD6rt8DVISo" shoogle-0.1.4/tests/test_shoogle.py0000755000175000017500000001430012714453376017642 0ustar arnauarnau00000000000000#!/usr/bin/env python # -*- coding: utf-8 -*- """ test_shoogle ---------------------------------- Tests for `shoogle` module. """ import collections from contextlib import contextmanager import json from io import StringIO import logging import re import sys import tempfile import unittest import shoogle from shoogle import lib from shoogle import config from . import secrets import jsmin def load_json(string): return json.loads(jsmin.jsmin(string)) @contextmanager def temporal_file(contents): with tempfile.NamedTemporaryFile() as fd: fd.write(bytes(contents, "utf8")) fd.flush() yield fd.name Execution = collections.namedtuple("Execution", ["status", "out", "err"]) def main(*args, **kwargs): old_stdout, old_stderr = sys.stdout, sys.stderr new_stdout, new_stderr = StringIO(), StringIO() sys.stdout, sys.stderr = new_stdout, new_stderr config.logger = lib.get_logger("shoogle-test", level=logging.ERROR, channel=new_stderr) try: status = shoogle.main(*args, **kwargs) finally: sys.stdout, sys.stderr = old_stdout, old_stderr return Execution(status=status, out=new_stdout.getvalue(), err=new_stderr.getvalue()) class TestShoogle(unittest.TestCase): def test_main_without_arguments_shows_usage_and_help_messages(self): e = main([]) self.assertEqual(2, e.status) self.assertIn("usage: ", e.err) self.assertIn("positional arguments:", e.err) self.assertIn("{show,execute}", e.err) self.assertIn("optional arguments:", e.err) def test_main_with_option_shows_usage_and_help_messages(self): e = main(["-h"]) self.assertEqual(2, e.status) self.assertIn("usage: ", e.out) self.assertIn("positional arguments:", e.out) self.assertIn("{show,execute}", e.out) self.assertIn("optional arguments:", e.out) def test_main_with_option_shows_version(self): e = main(["-v"]) self.assertEqual(0, e.status) self.assertEqual(shoogle.__version__, e.out.strip()) def test_main_with_empty_show_command_shows_all_services_sorted(self): e = main(["show"]) self.assertEqual(0, e.status) lines = e.out.splitlines() services = [line.split()[0] for line in lines] self.assertIn("webmasters:v3", services) self.assertIn("youtube:v3", services) self.assertEqual(list(sorted(services)), services) def test_main_with_string_show_command_shows_services_with_that_string(self): e = main(["show", "youtu"]) self.assertEqual(0, e.status) lines = e.out.splitlines() services = [line.split()[0] for line in lines] self.assertEqual(list(sorted(services)), services) for service in services: self.assertIn("youtu", service) def test_main_with_exact_service_string_shows_all_resources_sorted(self): e = main(["show", "youtube:v3"]) self.assertEqual(0, e.status) lines = e.out.splitlines() services = [line.split()[0] for line in lines] self.assertIn("youtube:v3.activities", services) self.assertIn("youtube:v3.videos", services) resources = [service.split(".")[-1] for service in services] self.assertEqual(list(sorted(resources)), resources) def test_main_with_partial_resource_string_shows_resources_sorted(self): e = main(["show", "youtube:v3.vid"]) lines = e.out.splitlines() resources = [line.split()[0] for line in lines] self.assertEqual(0, e.status) self.assertNotIn("youtube:v3.activities", resources) self.assertIn("youtube:v3.videos", resources) self.assertEqual(list(sorted(resources)), resources) def test_main_with_exact_resource_string_shows_all_methods_sorted(self): e = main(["show", "youtube:v3.videos"]) lines = e.out.splitlines() methods = [line.split()[0] for line in lines] self.assertEqual(0, e.status) self.assertIn("youtube:v3.videos.list", methods) self.assertIn("youtube:v3.videos.insert", methods) self.assertEqual(list(sorted(methods)), methods) def test_main_with_partial_method_string_shows_matching_methods_sorted(self): e = main(["show", "youtube:v3.videos.li"]) lines = e.out.splitlines() methods = [line.split()[0] for line in lines] self.assertEqual(0, e.status) self.assertIn("youtube:v3.videos.list", methods) self.assertNotIn("youtube:v3.videos.insert", methods) self.assertEqual(list(sorted(methods)), methods) def test_main_with_exact_method_shows_request_and_response_details(self): e = main(["show", "youtube:v3.videos.list"]) lines = e.out.splitlines() self.assertEqual(0, e.status) self.assertTrue("Request" in line for line in lines) self.assertTrue("Response" in line for line in lines) def test_main_with_exact_method_shows_request_with_minimal_params(self): e = main(["show", "urlshortener:v1.url.get"]) jsons = re.findall(r"^\{$.*?^\}$", e.out, re.MULTILINE | re.DOTALL) self.assertEqual(0, e.status) self.assertEqual(2, len(jsons)) request_json = load_json(jsons[0]) response_json = load_json(jsons[1]) self.assertEqual(["shortUrl"], list(request_json.keys())) self.assertEqual({"$ref": 'Url'}, response_json) def test_main_execute(self): request = """{ "key": "%s", "shortUrl": "http://goo.gl/Du5PSN" }""" % secrets.server_key with temporal_file(request) as request_file: e = main(["execute", "urlshortener:v1.url.get", request_file]) self.assertEqual(0, e.status) response = load_json(e.out) self.assertEqual(set(["id", "kind", "longUrl", "status"]), set(response.keys())) self.assertEqual(response["status"], "OK") def test_main_execute_with_missing_parameter(self): with temporal_file("{}") as request_file: e = main(["execute", "urlshortener:v1.url.get", request_file]) self.assertEqual(0, e.status) self.assertIn('Missing required parameter "shortUrl"', e.err) if __name__ == '__main__': sys.exit(unittest.main()) shoogle-0.1.4/tests/secrets.json0000644000175000017500000000007012711744164017123 0ustar arnauarnau00000000000000{ "key": "AIzaSyAknezZrIduryQGPecGwjPVXD6rt8DVISo", } shoogle-0.1.4/tests/secrets.py.template0000644000175000017500000000014712714453135020417 0ustar arnauarnau00000000000000# Rename this file to secrets.py and put your keys server_key = "YOUR_SECRET_KEY_OF_TYPE_SERVER_HERE" shoogle-0.1.4/tests/__init__.py0000755000175000017500000000003012704403064016661 0ustar arnauarnau00000000000000# -*- coding: utf-8 -*- shoogle-0.1.4/setup.cfg0000644000000000000000000000041612747455150014746 0ustar rootroot00000000000000[bumpversion] current_version = 0.1.4 commit = True tag = True [bumpversion:file:setup.py] [bumpversion:file:shoogle/__init__.py] [wheel] universal = 1 [flake8] exclude = docs [pep8] max-line-length = 100 [egg_info] tag_build = tag_date = 0 tag_svn_revision = 0 shoogle-0.1.4/MANIFEST.in0000644000175000017500000000030712705214132015145 0ustar arnauarnau00000000000000include CHANGELOG.md include LICENSE include README.md recursive-include tests * recursive-exclude * __pycache__ recursive-exclude * *.py[co] recursive-include docs *.rst conf.py Makefile make.bat shoogle-0.1.4/docs/0000755000000000000000000000000012747455150014054 5ustar rootroot00000000000000shoogle-0.1.4/docs/installation.rst0000644000175000017500000000032512704403064017575 0ustar arnauarnau00000000000000.. highlight:: shell ============ Installation ============ At the command line:: $ easy_install shoogle Or, if you have virtualenvwrapper installed:: $ mkvirtualenv shoogle $ pip install shoogle shoogle-0.1.4/docs/readme.rst0000644000175000017500000000003312704403064016325 0ustar arnauarnau00000000000000.. include:: ../README.rst shoogle-0.1.4/docs/make.bat0000644000175000017500000001447512704403064015762 0ustar arnauarnau00000000000000@ECHO OFF REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set BUILDDIR=_build set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . set I18NSPHINXOPTS=%SPHINXOPTS% . if NOT "%PAPER%" == "" ( set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% ) if "%1" == "" goto help if "%1" == "help" ( :help echo.Please use `make ^` where ^ is one of echo. html to make standalone HTML files echo. dirhtml to make HTML files named index.html in directories echo. singlehtml to make a single large HTML file echo. pickle to make pickle files echo. json to make JSON files echo. htmlhelp to make HTML files and a HTML help project echo. qthelp to make HTML files and a qthelp project echo. devhelp to make HTML files and a Devhelp project echo. epub to make an epub echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter echo. text to make text files echo. man to make manual pages echo. texinfo to make Texinfo files echo. gettext to make PO message catalogs echo. changes to make an overview over all changed/added/deprecated items echo. xml to make Docutils-native XML files echo. pseudoxml to make pseudoxml-XML files for display purposes echo. linkcheck to check all external links for integrity echo. doctest to run all doctests embedded in the documentation if enabled goto end ) if "%1" == "clean" ( for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i del /q /s %BUILDDIR%\* goto end ) %SPHINXBUILD% 2> nul if errorlevel 9009 ( echo. echo.The 'sphinx-build' command was not found. Make sure you have Sphinx echo.installed, then set the SPHINXBUILD environment variable to point echo.to the full path of the 'sphinx-build' executable. Alternatively you echo.may add the Sphinx directory to PATH. echo. echo.If you don't have Sphinx installed, grab it from echo.http://sphinx-doc.org/ exit /b 1 ) if "%1" == "html" ( %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/html. goto end ) if "%1" == "dirhtml" ( %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. goto end ) if "%1" == "singlehtml" ( %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. goto end ) if "%1" == "pickle" ( %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the pickle files. goto end ) if "%1" == "json" ( %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the JSON files. goto end ) if "%1" == "htmlhelp" ( %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run HTML Help Workshop with the ^ .hhp project file in %BUILDDIR%/htmlhelp. goto end ) if "%1" == "qthelp" ( %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: echo.^> qcollectiongenerator %BUILDDIR%\qthelp\shoogle.qhcp echo.To view the help file: echo.^> assistant -collectionFile %BUILDDIR%\qthelp\shoogle.ghc goto end ) if "%1" == "devhelp" ( %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp if errorlevel 1 exit /b 1 echo. echo.Build finished. goto end ) if "%1" == "epub" ( %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub if errorlevel 1 exit /b 1 echo. echo.Build finished. The epub file is in %BUILDDIR%/epub. goto end ) if "%1" == "latex" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex if errorlevel 1 exit /b 1 echo. echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. goto end ) if "%1" == "latexpdf" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex cd %BUILDDIR%/latex make all-pdf cd %BUILDDIR%/.. echo. echo.Build finished; the PDF files are in %BUILDDIR%/latex. goto end ) if "%1" == "latexpdfja" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex cd %BUILDDIR%/latex make all-pdf-ja cd %BUILDDIR%/.. echo. echo.Build finished; the PDF files are in %BUILDDIR%/latex. goto end ) if "%1" == "text" ( %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text if errorlevel 1 exit /b 1 echo. echo.Build finished. The text files are in %BUILDDIR%/text. goto end ) if "%1" == "man" ( %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man if errorlevel 1 exit /b 1 echo. echo.Build finished. The manual pages are in %BUILDDIR%/man. goto end ) if "%1" == "texinfo" ( %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo if errorlevel 1 exit /b 1 echo. echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. goto end ) if "%1" == "gettext" ( %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale if errorlevel 1 exit /b 1 echo. echo.Build finished. The message catalogs are in %BUILDDIR%/locale. goto end ) if "%1" == "changes" ( %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes if errorlevel 1 exit /b 1 echo. echo.The overview file is in %BUILDDIR%/changes. goto end ) if "%1" == "linkcheck" ( %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck if errorlevel 1 exit /b 1 echo. echo.Link check complete; look for any errors in the above output ^ or in %BUILDDIR%/linkcheck/output.txt. goto end ) if "%1" == "doctest" ( %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest if errorlevel 1 exit /b 1 echo. echo.Testing of doctests in the sources finished, look at the ^ results in %BUILDDIR%/doctest/output.txt. goto end ) if "%1" == "xml" ( %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml if errorlevel 1 exit /b 1 echo. echo.Build finished. The XML files are in %BUILDDIR%/xml. goto end ) if "%1" == "pseudoxml" ( %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml if errorlevel 1 exit /b 1 echo. echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. goto end ) :end shoogle-0.1.4/docs/conf.py0000755000175000017500000002030712704403064015646 0ustar arnauarnau00000000000000#!/usr/bin/env python # -*- coding: utf-8 -*- # # shoogle documentation build configuration file, created by # sphinx-quickstart on Tue Jul 9 22:26:36 2013. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys import os # If extensions (or modules to document with autodoc) are in another # directory, add these directories to sys.path here. If the directory is # relative to the documentation root, use os.path.abspath to make it # absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) # Get the project root dir, which is the parent dir of this cwd = os.getcwd() project_root = os.path.dirname(cwd) # Insert the project root dir as the first element in the PYTHONPATH. # This lets us ensure that the source package is imported, and that its # version is used. sys.path.insert(0, project_root) import shoogle # -- General configuration --------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = u'Shoogle' copyright = u'2016, Arnau Sanchez' # The version info for the project you're documenting, acts as replacement # for |version| and |release|, also used in various other places throughout # the built documents. # # The short X.Y version. version = shoogle.__version__ # The full version, including alpha/beta/rc tags. release = shoogle.__version__ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to # some non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all # documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built # documents. #keep_warnings = False # -- Options for HTML output ------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a # theme further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as # html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the # top of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon # of the docs. This file should be a Windows icon file (.ico) being # 16x16 or 32x32 pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) # here, relative to this directory. They are copied after the builtin # static files, so a file named "default.css" will overwrite the builtin # "default.css". html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page # bottom, using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names # to template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. # Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. # Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages # will contain a tag referring to it. The value of this option # must be the base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'shoogledoc' # -- Options for LaTeX output ------------------------------------------ latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass # [howto/manual]). latex_documents = [ ('index', 'shoogle.tex', u'Shoogle Documentation', u'Arnau Sanchez', 'manual'), ] # The name of an image file (relative to this directory) to place at # the top of the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings # are parts, not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output ------------------------------------ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'shoogle', u'Shoogle Documentation', [u'Arnau Sanchez'], 1) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ---------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'shoogle', u'Shoogle Documentation', u'Arnau Sanchez', 'shoogle', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False shoogle-0.1.4/docs/contributing.rst0000644000175000017500000000004112704403064017576 0ustar arnauarnau00000000000000.. include:: ../CONTRIBUTING.rst shoogle-0.1.4/docs/Makefile0000644000175000017500000001515612704403064016012 0ustar arnauarnau00000000000000# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) endif # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" @echo " text to make text files" @echo " man to make manual pages" @echo " texinfo to make Texinfo files" @echo " info to make Texinfo files and run them through makeinfo" @echo " gettext to make PO message catalogs" @echo " changes to make an overview of all changed/added/deprecated items" @echo " xml to make Docutils-native XML files" @echo " pseudoxml to make pseudoxml-XML files for display purposes" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/shoogle.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/shoogle.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/shoogle" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/shoogle" @echo "# devhelp" epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." latexpdfja: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through platex and dvipdfmx..." $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." texinfo: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." gettext: $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." xml: $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml @echo @echo "Build finished. The XML files are in $(BUILDDIR)/xml." pseudoxml: $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." shoogle-0.1.4/docs/history.rst0000644000175000017500000000003412704403064016572 0ustar arnauarnau00000000000000.. include:: ../HISTORY.rst shoogle-0.1.4/docs/authors.rst0000644000175000017500000000003412704403064016556 0ustar arnauarnau00000000000000.. include:: ../AUTHORS.rst shoogle-0.1.4/docs/usage.rst0000644000175000017500000000010512704403064016174 0ustar arnauarnau00000000000000===== Usage ===== To use Shoogle in a project:: import shoogle shoogle-0.1.4/docs/index.rst0000644000175000017500000000076512704403064016213 0ustar arnauarnau00000000000000.. shoogle documentation master file, created by sphinx-quickstart on Tue Jul 9 22:26:36 2013. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to Shoogle's documentation! ====================================== Contents: .. toctree:: :maxdepth: 2 readme installation usage contributing authors history Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` shoogle-0.1.4/CHANGELOG.md0000644000175000017500000000024012704771273015231 0ustar arnauarnau00000000000000# ChangeLog ## [0.1.0] * Provides infrastructure for Oauth2 authentication (console and browser). * Exposes all services supported by the Python Gooogle API. shoogle-0.1.4/PKG-INFO0000644000000000000000000001526112747455150014226 0ustar rootroot00000000000000Metadata-Version: 1.1 Name: shoogle Version: 0.1.4 Summary: Google API from the command line Home-page: https://github.com/tokland/shoogle Author: Arnau Sanchez Author-email: pyarnau@gmail.com License: ISCL Description: Shoogle ======= Use the Google API from the shell. An example, get the long URL using the *urlshortener* service: :: $ echo '{"shortUrl": "http://goo.gl/Du5PSN"}' | shoogle execute urlshortener:v1.url.get - { "status": "OK", "id": "http://goo.gl/Du5PSN", "longUrl": "http://1.bp.blogspot.com/-R0HSXDqlJI8/Tr67i-kr7hI/AAAAAAABMko/gaId6iYuhjA/s1600/12_%252520Cross%252520that%252520bridge%252520when%252520we%252520come%252520to%252520it.jpg", "kind": "urlshortener#url" } Install ------- Dependencies ~~~~~~~~~~~~ - Python >= 3.0 From PyPi ~~~~~~~~~ :: $ sudo pip install shoogle From sources ~~~~~~~~~~~~ :: $ wget https://github.com/tokland/shoogle/archive/master.zip $ unzip master.zip $ cd shoogle-master $ sudo pip install pypandoc $ sudo python setup.py install Features -------- - Exposes agnostically all the services in the API. - Provides infrastructure for the Oauth2 authentication (console or QT/GTK browser). - Shows information from the Google Discovery API to help build the JSON requests. - Save credentials for each set of scopes. Setup: configure the API and secret keys ---------------------------------------- - You must enable the services you want to use and create the required keys or secret file in the `API Manager `_. Each service has its own policies, check the Google documentation for more details. Commands -------- show ~~~~ Incrementally show details of services/resources/methods: :: $ shoogle show adexchangebuyer2:v2beta1 - Ad Exchange Buyer API II adexchangebuyer:v1.2 - Ad Exchange Buyer API ... youtubeAnalytics:v1beta1 - YouTube Analytics API youtubereporting:v1 - YouTube Reporting API :: $ shoogle show short urlshortener:v1 - URL Shortener API :: $ shoogle show urlshortener:v1 urlshortener:v1.url :: $ shoogle show urlshortener:v1.url urlshortener:v1.url.get - Expands a short URL or gets creation time and analytics. urlshortener:v1.url.insert - Creates a new short URL. urlshortener:v1.url.list - Retrieves a list of URLs shortened by a user. :: $ shoogle show urlshortener:v1.url.get [INFO] Response (level=0, --debug-response-level=N to change): { "$ref": "Url" } [INFO] Request (level=1, --debug-request-level=N to change): { "shortUrl": "(string) The short URL, including the protocol - required" } execute ~~~~~~~ - Expand a short URL: :: $ cat get-longurl.json { "key": "YOUR_SECRET_KEY", // You can use JS comments! "shortUrl": "http://goo.gl/Du5PSN" } $ shoogle execute urlshortener:v1.url.get get-longurl.json { "status": "OK", "id": "http://goo.gl/Du5PSN", "longUrl": "http://1.bp.blogspot.com/-R0HSXDqlJI8/Tr67i-kr7hI/AAAAAAABMko/gaId6iYuhjA/s1600/12_%252520Cross%252520that%252520bridge%252520when%252520we%252520come%252520to%252520it.jpg", "kind": "urlshortener#url" } - `jq `_ is a command-line JSON builder/parser. This example shows how to upload a video from a JSON template and extract the ID from the response: :: $ cat upload-video.template.json { "part": "snippet", "body": { "snippet": { "title": $title, "description": $description } } } :: $ jq -n -f upload-video.template.json --arg title "Chess" --arg description "Norway Chess" | shoogle execute -c your_client_id.json youtube:v3.videos.insert - -f chess.mp4 | jq -r '.id' wUArz2nPGqA More ---- - License: `GNU/GPLv3 `_. Feedback -------- - Issues: Please open issues only to report bugs of the package. If you have problems regarding how to use the API itself (what auth is required, how to create those auth files, how to build the request parameters, quotas management, etc), use the `Google Forums `_ or `StackOverflow `_. - `Want to donate? `_ ChangeLog ========= [0.1.0] ------- - Provides infrastructure for Oauth2 authentication (console and browser). - Exposes all services supported by the Python Gooogle API. Keywords: shoogle Platform: UNKNOWN Classifier: Development Status :: 4 - Beta Classifier: Intended Audience :: End Users/Desktop Classifier: License :: OSI Approved :: GNU General Public License (GPL) Classifier: Natural Language :: English Classifier: Operating System :: POSIX Classifier: Operating System :: Microsoft :: Windows Classifier: Topic :: Internet :: WWW/HTTP Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.3 Classifier: Programming Language :: Python :: 3.4 Classifier: Programming Language :: Python :: 3.5 shoogle-0.1.4/LICENSE0000644000175000017500000010450512705217737014437 0ustar arnauarnau00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. {one line to give the program's name and a brief idea of what it does.} Copyright (C) {year} {name of author} This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: {project} Copyright (C) {year} {fullname} This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . shoogle-0.1.4/shoogle/0000755000000000000000000000000012747455150014564 5ustar rootroot00000000000000shoogle-0.1.4/shoogle/config.py0000644000175000017500000000046012711155572016677 0ustar arnauarnau00000000000000import logging import os import sys from . import lib logger = lib.get_logger("shoogle", level=logging.ERROR, channel=sys.stderr) config_dir = os.path.join(os.path.expanduser("~"), ".shoogle") cache_dir = os.path.join(config_dir, "cache") credentials_base_dir = os.path.join(config_dir, "credentials") shoogle-0.1.4/shoogle/common.py0000644000175000017500000000670212711445340016722 0ustar arnauarnau00000000000000"""Common utility function for shoogle commands.""" import collections import uuid import json import glob import os import re import httplib2 from . import lib from . import config from .config import logger class ShoogleException(Exception): """Used for controlled exceptions of the app.""" pass def download(url): """ Return the content of a URL if the HTTP_STATUS is 2XX, otherwise raise a ShoogleException with a description of the problem. """ logger.info("GET {}".format(url)) http = httplib2.Http(cache=config.cache_dir) headers, content = http.request(url, "GET") if re.match("2..", str(headers.status)): return content.decode('utf-8') else: raise ShoogleException("GET {} ({})".format(url, headers.status)) def get_services(): """Return a dictionary {service_id, service}.""" apis = download("https://www.googleapis.com/discovery/v1/apis") services = lib.load_json(apis)["items"] return dict((service["id"], service) for service in services) def get_credentials_path(required_scopes, credentials_profile): """Return the path of the credentials file.""" logger.debug("Searching credentials with scopes: " + str(required_scopes)) basedir = config.credentials_base_dir credentials_dir = os.path.join(basedir, credentials_profile) lib.mkdir_p(credentials_dir) for path in glob.glob(os.path.join(credentials_dir, "*.json")): credentials = json.load(open(path)) credentials_scope = set(credentials.get("scopes", [])) if credentials_scope.issuperset(required_scopes): logger.info("Using credentials: {}".format(path)) return path uuid_value = str(uuid.uuid1()) filename = "credentials-{uuid}.json".format(uuid=uuid_value) new_path = os.path.join(credentials_dir, filename) logger.debug("No credentials for scopes, create new file: " + new_path) return new_path def get_service(service_id): """Return the service from its ID. Raise ShoogleException if not found.""" services = get_services() if service_id not in services: raise ShoogleException("Service API not found: {}".format(service_id)) else: service = services[service_id] service_json = download(service["discoveryRestUrl"]) return lib.load_json(service_json) def get_method(service, resource_name, method_name): """Return the method for a service/resource. Raise ShoogleException if not found.""" if resource_name not in service["resources"]: raise ShoogleException("Resource not found: {}".format(resource_name)) elif method_name not in service["resources"][resource_name]["methods"]: raise ShoogleException("Method not found: {}".format(method_name)) else: return service["resources"][resource_name]["methods"][method_name] def replace_schemas(schemas, params, max_level=None, level=0): """Replace JSON references (key=$ref) for properties.""" output = collections.OrderedDict() for key, value in sorted(params.items()): if max_level is not None and level >= max_level: output[key] = value elif key == "$ref": properties = schemas[value].get("properties", schemas[value]) output.update(replace_schemas(schemas, properties, max_level, level + 1)) elif isinstance(value, dict): output[key] = replace_schemas(schemas, value, max_level, level + 1) else: output[key] = value return output shoogle-0.1.4/shoogle/a.py0000644000175000017500000000002212720533540015637 0ustar arnauarnau00000000000000class Dog: pass shoogle-0.1.4/shoogle/lib.py0000644000175000017500000000257712711155061016204 0ustar arnauarnau00000000000000"""Miscellanious helper utils.""" import errno import os import logging import sys import json import jsmin def get_logger(name, level=logging.INFO, channel=sys.stderr): """Return a Logger object.""" logger_format = '[%(levelname)s] %(message)s' logger = logging.getLogger(name) logger.setLevel(level) handler = logging.StreamHandler(channel) handler.setLevel(level) formatter = logging.Formatter(logger_format) handler.setFormatter(formatter) logger.addHandler(handler) return logger def merge(dict1, dict2): """Return merged dictionaries (repeated keys are set to dict2 values).""" dict3 = dict1.copy() dict3.update(dict2) return dict3 def pad_list(lst, size): """Return list with exactly elements.""" return lst[:size] + [None] * (size - len(lst)) def output(obj): """Print to stdout.""" print(str(obj)) def mkdir_p(path): """Create directory if non-existing, otherwise do nothing.""" try: os.makedirs(path) except OSError as exc: if exc.errno == errno.EEXIST and os.path.isdir(path): pass else: raise def pretty_json(obj): """Return pretty JSON string representation of a Python object.""" return json.dumps(obj, indent=2) def load_json(json_string): """Return Python object from JSON string.""" return json.loads(jsmin.jsmin(json_string)) shoogle-0.1.4/shoogle/commands/0000755000000000000000000000000012747455150016365 5ustar rootroot00000000000000shoogle-0.1.4/shoogle/commands/show.py0000644000175000017500000001401112711160345020202 0ustar arnauarnau00000000000000import collections import re from .. import lib from .. import common from ..config import logger def add_parser(subparsers, name): parser = subparsers.add_parser(name) parser.add_argument('--debug-request-level', type=int, default=1, help='Levels to show of the example request body') parser.add_argument('--debug-response-level', type=int, default=0, help='Levels to show of the response schema on debug messages') parser.add_argument('api_path', metavar="API_PATH", nargs='?', default="", help="SERVICE:VERSION.RESOURCE.METHOD") def run(options): parts = options.api_path.split(".", 2) service_id, resource_name, method_name = lib.pad_list(parts, 3) if resource_name is None: show_services(service_id, options) elif method_name is None: show_resources(service_id, resource_name, options) else: show_methods(service_id, resource_name, method_name, options) def show_services(search_service_id, options): services = common.get_services() filtered_services = [(service_id, item) for (service_id, item) in services.items() if re.search(search_service_id, service_id)] if len(filtered_services) == 0: logger.info("API service not found: {}".format(search_service_id)) elif len(filtered_services) == 1 and search_service_id in services: show_resources(search_service_id, "", options) else: for service_id, item in sorted(filtered_services): if re.search(search_service_id, service_id): lib.output("{id} - {title}".format(id=service_id, title=item["title"])) def show_resources(service_id, search_resource_name, options): resources = common.get_service(service_id)["resources"] filtered_resources = [ (resource_name, resource) for (resource_name, resource) in resources.items() if re.search(search_resource_name, resource_name) ] if len(filtered_resources) == 0: logger.info("Resource not found in service {}: {}".format(service_id, search_resource_name)) elif len(filtered_resources) == 1 and search_resource_name in resources: show_methods(service_id, search_resource_name, "", options) else: for resource_name, resource in sorted(filtered_resources): lib.output("{service}.{name}".format( service=service_id, name=resource_name, )) def show_methods(service_id, resource_name, search_method_name, options): service = common.get_service(service_id) logger.info("Service documentation: {}".format(service["documentationLink"])) methods = service["resources"][resource_name]["methods"] filtered_methods = [ (method_name, method) for (method_name, method) in methods.items() if re.search(search_method_name, method_name) ] if len(filtered_methods) == 0: logger.info("Method not found in {service}.{resource}: {method}".format( service=service_id, resource=resource_name, method=search_method_name, )) elif len(filtered_methods) == 1 and search_method_name in methods: show_method(service, methods[search_method_name], options) else: for method_name, method in sorted(filtered_methods): lib.output("{service}.{resource}.{name} - {description}".format( service=service_id, resource=resource_name, name=method_name, description=method["description"], )) def get_example_request(params, schemas, max_level): request = collections.OrderedDict() for parameter_name, parameter in sorted(params): if isinstance(parameter, dict): request[parameter_name] = common.replace_schemas(schemas, parameter, max_level, 1) else: opts = parameter.opts description = re.sub("\.\s*$", "", opts["description"].splitlines()[0]) extra_info = { "default": opts.get("default"), "values": ", ".join(opts.get("enum", [])) } extra_info_string = ", ".join("{}: {}".format(k, v) for (k, v) in extra_info.items() if v) parameter_info = " - ".join(["({type}) {description}", "{required}{default}"]).format( name=parameter_name, type=opts["type"], required=("required" if opts.get("required") else "optional"), description=description, default=(" ({})".format(extra_info_string) if extra_info_string else ""), ) request[parameter_name] = parameter_info return request def show_method(service, method, options): schemas = service["schemas"] max_level = options.debug_response_level response = common.replace_schemas(schemas, method.get("response", {}), max_level=max_level) build_param = collections.namedtuple("Param", ["opts"]) service_params = [(k, build_param(v)) for (k, v) in service.get("parameters", {}).items()] method_params = [(k, build_param(v)) for (k, v) in method.get("parameters", {}).items()] required_service_params = [(k, p) for (k, p) in service_params if p.opts.get("required")] required_method_params = [(k, p) for (k, p) in method_params if p.opts.get("required")] body_params = ([("body", method.get("request"))] if method.get("request") else []) minimal_params = sorted(required_service_params + required_method_params) + body_params all_params = sorted(service_params + method_params + body_params) level = options.debug_request_level request = get_example_request(minimal_params, schemas, level) lib.output("{id}: {description}".format(id=method["id"], description=method["description"])) lib.output("Request (level={max_level}, --debug-request-level=N to change):\n{request}" .format(max_level=level, request=lib.pretty_json(request))) lib.output("Response (level={max_level}, --debug-response-level=N to change):\n{response}" .format(max_level=max_level, response=lib.pretty_json(response))) shoogle-0.1.4/shoogle/commands/execute.py0000644000175000017500000001263212735755652020714 0ustar arnauarnau00000000000000"""Execute command: send request to service.""" import inspect import os import sys import apiclient import googleapiclient import httplib2 from .. import auth from .. import common from .. import config from .. import lib def add_parser(main_parser, name): """Add specific execute command parser.""" parser = main_parser.add_parser(name) parser.add_argument('-c', '--client-secret-file', metavar="PATH", help="Use a client secret JSON file") parser.add_argument('-f', '--media-file', metavar="PATH", help='File to use for media-related methods') parser.add_argument('--browser-auth', action="store_true", help="Use a browser to authentify") parser.add_argument('--credentials-file', metavar="PATH", help="Select credentials file to use") parser.add_argument('--credentials-profile', default="default", metavar="NAME", help="Select credentials profile to use") parser.add_argument('api_path', metavar="API_PATH", help="SERVICE:VERSION.RESOURCE.METHOD") parser.add_argument('json_request', metavar="JSON_FILE", help="File containing the request JSON (use '-' to read from STDIN)") def run(options): """Run command execute.""" service_id, resource_name, method_name = lib.pad_list(options.api_path.split(".", 2), 3) request_fd = (sys.stdin if options.json_request == "-" else open(options.json_request)) method_options = lib.load_json(request_fd.read()) try: response = do_request(service_id, resource_name, method_name, method_options, options) lib.output(lib.pretty_json(response)) except TypeError as error: frm = inspect.trace()[-1] mod = inspect.getmodule(frm[0]) if mod.__name__ == 'googleapiclient.discovery': config.logger.error("googleapiclient.discovery: {}".format(error)) else: raise def execute_media_request(request): """Process a request containing a MediaFileUpload.""" while 1: status, response = request.next_chunk() if status: config.logger.debug("MediaFileUpload status: {}".format(status)) if response: return response def build_service(service_id, credentials): """Return service object from ID and credentials.""" base_http = httplib2.Http() http = (credentials.authorize(base_http) if credentials else base_http) service_name, version = service_id.split(":", 1) return googleapiclient.discovery.build(service_name, version, http=http) def get_credentials(scopes, options): """Return path of the reusable credentials JSON file for given scopes.""" if scopes and options.client_secret_file: if options.credentials_file: if os.path.exists(options.credentials_file): credentials_path = options.credentials_file else: msg = "Credentials file not found: {}".format(options.credentials_file) raise common.ShoogleException(msg) else: credentials_path = common.get_credentials_path(scopes, options.credentials_profile) if options.browser_auth: from shoogle.auth import browser get_code = auth.browser.get_code else: from shoogle.auth import console get_code = auth.console.get_code client_secret = options.client_secret_file return auth.get_credentials(client_secret, credentials_path, scopes, get_code) else: return None def get_method_options_with_media(method_options, media_file): """Return options to send the method caller from base options and media file.""" media_body = apiclient.http.MediaFileUpload( media_file, chunksize=-1, resumable=True, mimetype="application/octet-stream", ) media_file_field = "MediaFileUpload({})".format(media_file) printable_request = lib.merge(method_options, {"media_body": media_file_field}) config.logger.debug("Request: " + lib.pretty_json(printable_request)) return lib.merge(method_options, {"media_body": media_body}) def do_request(service_id, resource_name, method_name, method_options, options): """Send request to API and return JSON response.""" service = common.get_service(service_id) method = common.get_method(service, resource_name, method_name) if method.get("request") and "body" not in method_options: raise common.ShoogleException("This method need a body property in the request") elif method.get("supportsMediaUpload") and not options.media_file: raise common.ShoogleException("This method requires a media file (--media-file=PATH)") else: scopes = method.get("scopes", []) credentials = get_credentials(scopes, options) service_obj = build_service(service_id, credentials) resource_func = getattr(service_obj, resource_name) method_func = getattr(resource_func(), method_name) if options.media_file: method_options_with_media = \ get_method_options_with_media(method_options, options.media_file) request = method_func(**method_options_with_media) return execute_media_request(request) else: config.logger.debug("Request: " + lib.pretty_json(method_options)) request = method_func(**method_options) return request.execute() shoogle-0.1.4/shoogle/commands/__init__.py0000644000175000017500000000005212711125421020755 0ustar arnauarnau00000000000000from . import show from . import execute shoogle-0.1.4/shoogle/auth/0000755000000000000000000000000012747455150015525 5ustar rootroot00000000000000shoogle-0.1.4/shoogle/auth/browser.py0000644000175000017500000000356212711456066020066 0ustar arnauarnau00000000000000"""Auth module that uses a QT or GTK browser to prompt the user.""" import signal from contextlib import contextmanager from PyQt4 import QtCore, QtGui, QtWebKit CHECK_AUTH_JS = """ var code = document.getElementById("code"); var access_denied = document.getElementById("access_denied"); var result; if (code) { result = {authorized: true, code: code.value}; } else if (access_denied) { result = {authorized: false, message: access_denied.innerText}; } else { result = {}; } result; """ @contextmanager def default_sigint(): """Context manager that sets SIGNINT to the default value.""" original_sigint_handler = signal.getsignal(signal.SIGINT) signal.signal(signal.SIGINT, signal.SIG_DFL) try: yield finally: signal.signal(signal.SIGINT, original_sigint_handler) WEBKIT_BACKEND = "qt" def _on_qt_page_load_finished(dialog, webview): frame = webview.page().currentFrame() res = frame.evaluateJavaScript(CHECK_AUTH_JS) authorization = dict((k, v) for (k, v) in res.items()) if "authorized" in authorization: dialog.authorization_code = authorization.get("code") dialog.close() def get_code(url, size=(640, 480), title="Google authentication"): """Open a QT webkit window and return the access code.""" app = QtGui.QApplication([]) dialog = QtGui.QDialog() dialog.setWindowTitle(title) dialog.resize(*size) webview = QtWebKit.QWebView() webpage = QtWebKit.QWebPage() webview.setPage(webpage) webpage.loadFinished.connect(lambda: _on_qt_page_load_finished(dialog, webview)) webview.setUrl(QtCore.QUrl.fromEncoded(url)) layout = QtGui.QGridLayout() layout.addWidget(webview) dialog.setLayout(layout) dialog.authorization_code = None dialog.show() app.exec_() return dialog.authorization_code shoogle-0.1.4/shoogle/auth/console.py0000644000175000017500000000121412711444053020026 0ustar arnauarnau00000000000000"""Auth module that uses the console to prompt the user.""" import sys import contextlib @contextlib.contextmanager def stdin_replaced_by(new_stdin): """Context manager that changes temporally sys.stdin.""" old_stdin = sys.stdin try: sys.stdin = new_stdin yield finally: sys.stdin = old_stdin def get_code(authorize_url): """Show authorization URL and return the code that the user wrote.""" message = "Check this link in your browser: {0}".format(authorize_url) print(message + "\n", file=sys.stderr) with stdin_replaced_by(open('/dev/tty')): return input("Enter verification code: ") shoogle-0.1.4/shoogle/auth/auth.py0000644000175000017500000000221012711443562017326 0ustar arnauarnau00000000000000"""Wrapper for Google OAuth2 API.""" import oauth2client.client from oauth2client.file import Storage from . import console def _get_credentials_interactively(flow, storage, get_code_callback): """Return the credentials asking the user.""" flow.redirect_uri = oauth2client.client.OOB_CALLBACK_URN authorize_url = flow.step1_get_authorize_url() code = get_code_callback(authorize_url) if code: credential = flow.step2_exchange(code, http=None) storage.put(credential) credential.set_store(storage) return credential def get_credentials(client_secrets_file, credentials_file, scope, get_code_callback=console.get_code): """Return the user credentials from the file or run the interactive flow.""" get_flow = oauth2client.client.flow_from_clientsecrets flow = get_flow(client_secrets_file, scope=scope) storage = Storage(credentials_file) existing_credentials = storage.get() if existing_credentials and not existing_credentials.invalid: return existing_credentials else: return _get_credentials_interactively(flow, storage, get_code_callback) shoogle-0.1.4/shoogle/auth/__init__.py0000644000175000017500000000015612735755652020147 0ustar arnauarnau00000000000000"""Auth to Google API using console, browser or custom user interaction.""" from .auth import get_credentials shoogle-0.1.4/shoogle/shoogle.py0000755000175000017500000000414012711155677017102 0ustar arnauarnau00000000000000"""Use the Google API from the command-line.""" import argparse import json import logging import sys import oauth2client.client import googleapiclient.errors import googleapiclient.discovery from . import __version__ from . import lib from . import common from . import commands from . import config def get_parser(description): """Return an ArgumentParser for the command-line app.""" parser = argparse.ArgumentParser(description=description) parser.add_argument('-v', '--version', action="store_true", help="Show version and exit") subparsers = parser.add_subparsers(help='Commands', dest="command") subparsers.required = False commands.show.add_parser(subparsers, "show") commands.execute.add_parser(subparsers, "execute") return parser def run(args): """Parse options and run shoogle commands. Return status code.""" parser = get_parser("Command-line interface for the Google API.") try: options = parser.parse_args(args) except SystemExit: return 2 if options.version: lib.output(__version__) return 0 elif options.command == "show": commands.show.run(options) return 0 elif options.command == "execute": commands.execute.run(options) return 0 else: parser.print_help(sys.stderr) return 2 def main(args): """Run shoogle with command-line arguments and return status code.""" logger = config.logger try: return run(args) except common.ShoogleException as error: logger.error(error) return 1 except googleapiclient.errors.HttpError as error: status = error.resp["status"] data = bytes.decode(error.content).strip() logger.error("Server error response ({0}): {1}".format(status, data)) return 3 except oauth2client.client.FlowExchangeError as error: logger.error("OAuth 2 error: {}".format(error)) except json.decoder.JSONDecodeError as error: logger.error("JSONDecodeError({}): {}".format(str(error), error.doc)) return 4 if __name__ == '__main__': sys.exit(run(sys.argv[:1])) shoogle-0.1.4/shoogle/__init__.py0000755000175000017500000000015312747455147017205 0ustar arnauarnau00000000000000__author__ = 'Arnau Sanchez' __email__ = 'pyarnau@gmail.com' __version__ = '0.1.4' from .shoogle import * shoogle-0.1.4/bin/0000755000000000000000000000000012747455150013674 5ustar rootroot00000000000000shoogle-0.1.4/bin/shoogle0000755000175000017500000000047112705217737015565 0ustar arnauarnau00000000000000#!/usr/bin/env python def add_parent_directory_to_sys_path(): current_directory = os.path.dirname(os.path.realpath(__file__)) sys.path.insert(0, os.path.join(current_directory, os.pardir)) import os.path import sys add_parent_directory_to_sys_path() import shoogle sys.exit(shoogle.main(sys.argv[1:]))