Welcome to gae-contentful-proxy’s documentation!

Module based on top of Google Cloud Platform which creates simple proxy for Contentful API.

contentful_proxy

contentful_proxy package

Subpackages

contentful_proxy.handlers package
Subpackages
contentful_proxy.handlers.cron package
Submodules
contentful_proxy.handlers.cron.files_job module
Module contents
contentful_proxy.handlers.mixins package
Submodules
contentful_proxy.handlers.mixins.base module
Module contents
Submodules
contentful_proxy.handlers.assets module
contentful_proxy.handlers.files module
contentful_proxy.handlers.items module
contentful_proxy.handlers.managements module
Module contents
contentful_proxy.models package
Submodules
contentful_proxy.models.files module
Module contents
contentful_proxy.tests package
Subpackages
contentful_proxy.tests.test_handlers package
Submodules
contentful_proxy.tests.test_handlers.conftest module
contentful_proxy.tests.test_handlers.test_assets module
contentful_proxy.tests.test_handlers.test_cache_file module
contentful_proxy.tests.test_handlers.test_items module
Module contents
Submodules
contentful_proxy.tests.conftest module
Module contents
contentful_proxy.utils package
Subpackages
contentful_proxy.utils.cache package
Submodules
contentful_proxy.utils.cache.transformations module
Module contents
contentful_proxy.utils.handlers package
Submodules
contentful_proxy.utils.handlers.storage module
contentful_proxy.utils.handlers.webapp2_base module
Module contents
contentful_proxy.utils.pytest package
Module contents
Module contents

Submodules

contentful_proxy.appengine_config module

contentful_proxy.routing module

Module contents

Example usage

  1. Requirements:

    pip install -r requirements.txt
    
  2. Example file with handlers:

    from contentful_proxy import routes
    
    app = webapp2.WSGIApplication(
       routes.contentful_routes + routes.cron_routes,
       debug=True
    )
    
  3. Example App Engine settings file (app.yaml):

    api_version: 1
    
    builtins:
    - deferred: true
    
    env_variables:
      CONTENTFUL_SPACE: {CONTENTFUL_SPACE}
      CONTENTFUL_SPACE_ID: {CONTENTFUL_SPACE_ID}
      CONTENTFUL_MANAGEMENT_TOKEN: {CONTENTFUL_MANAGEMENT_TOKEN}
    
    handlers:
    - url: /_ah/queue/deferred
      login: admin
      script: google.appengine.ext.deferred.deferred.application
    - url: /ah/cron/.*
      login: admin
      script: main.app
    - url: .*
      script: main.app
    
    instance_class: F1
    
    libraries:
    - name: webapp2
      version: 2.5.2
    - name: ssl
      version: 2.7.11
    - name: webob
      version: latest
    
    runtime: python27
    threadsafe: true
    
  4. Example cron:

    cron:
    - description: Delete old cached files
      url: /_ah/cron/clean-up-files
      schedule: every day 2:00
      timezone: Europe/Berlin
    

Indices and tables