OLD | NEW |
(Empty) | |
| 1 Metadata-Version: 1.1 |
| 2 Name: google-endpoints-api-management |
| 3 Version: 1.0.0 |
| 4 Summary: Google Endpoints API management |
| 5 Home-page: https://github.com/cloudendpoints/endpoints-management-python |
| 6 Author: Google Inc |
| 7 Author-email: googleapis-packages@google.com |
| 8 License: Apache License |
| 9 Description: Google Endpoints API Management |
| 10 =============================== |
| 11 |
| 12 |
| 13 .. image:: https://travis-ci.org/cloudendpoints/endpoints-management-pyt
hon.svg?branch=master |
| 14 :target: https://travis-ci.org/cloudendpoints/endpoints-management-p
ython |
| 15 .. image:: https://codecov.io/gh/cloudendpoints/endpoints-management-pyt
hon/branch/master/graph/badge.svg |
| 16 :target: https://codecov.io/gh/cloudendpoints/endpoints-management-p
ython |
| 17 |
| 18 |
| 19 Google Endpoints API Management manages the 'control plane' of an API by |
| 20 providing support for authentication, billing, monitoring and quota cont
rol. |
| 21 |
| 22 It achieves this by |
| 23 |
| 24 - allowing HTTP servers to control access to their APIs using the Google
Service Management and Google Service Control APIs |
| 25 - providing built-in, standards-compliant support for third-party authen
tication |
| 26 - doing this with minimal performance impact via the use of advanced cac
hing and aggregation algorithms |
| 27 - making this easy to integrate via a set of `WSGI`_ middleware |
| 28 |
| 29 .. _`WSGI`: https://wsgi.readthedocs.io/en/latest/ |
| 30 |
| 31 |
| 32 Example: |
| 33 |
| 34 .. code:: python |
| 35 |
| 36 >>> application = MyWsgiApp() # an existing WSGI application |
| 37 >>> |
| 38 >>> # the name of the controlled service |
| 39 >>> service_name = 'my-service-name' |
| 40 >>> |
| 41 >>> # The Id of a Google Cloud project with the Service Control and S
ervice Management |
| 42 >>> # APIs enabled |
| 43 >>> project_id = 'my-project-id' |
| 44 >>> |
| 45 >>> # wrap the app for service control |
| 46 >>> from google.api.control import client, wsgi |
| 47 >>> control_client = client.Loaders.DEFAULT.load(service_name) |
| 48 >>> control_client.start() |
| 49 >>> controlled_app = wsgi.add_all(application, project_id, control_cl
ient) |
| 50 >>> |
| 51 >>> # now use the controlled in place of application |
| 52 >>> my_server.serve(controlled_app) |
| 53 |
| 54 |
| 55 Installation |
| 56 ------------- |
| 57 |
| 58 Install using `pip`_ |
| 59 |
| 60 .. code:: bash |
| 61 |
| 62 [sudo] pip install google-endpoints-api-management |
| 63 |
| 64 .. _`pip`: https://pip.pypa.io |
| 65 |
| 66 |
| 67 Python Versions |
| 68 --------------- |
| 69 |
| 70 endpoints-management-python is currently tested with Python 2.7. |
| 71 |
| 72 |
| 73 Contributing |
| 74 ------------ |
| 75 |
| 76 Contributions to this library are always welcome and highly encouraged. |
| 77 |
| 78 See the `CONTRIBUTING documentation`_ for more information on how to get
started. |
| 79 |
| 80 .. _`CONTRIBUTING documentation`: https://github.com/cloudendpoints/endp
oints-management-python/blob/master/CONTRIBUTING.rst |
| 81 |
| 82 |
| 83 Versioning |
| 84 ---------- |
| 85 |
| 86 This library follows `Semantic Versioning`_ |
| 87 |
| 88 .. _`Semantic Versioning`: http://semver.org/ |
| 89 |
| 90 |
| 91 Details |
| 92 ------- |
| 93 |
| 94 For detailed documentation of the modules in endpoints-management-python
, please watch `DOCUMENTATION`_. |
| 95 |
| 96 .. _`DOCUMENTATION`: https://endpoints-management-python.readthedocs.org
/ |
| 97 |
| 98 |
| 99 License |
| 100 ------- |
| 101 |
| 102 Apache - See `the full LICENSE`_ for more information. |
| 103 |
| 104 .. _`the full LICENSE`: https://github.com/cloudendpoints/endpoints-mana
gement-python/blob/master/LICENSE |
| 105 |
| 106 Platform: UNKNOWN |
| 107 Classifier: Development Status :: 4 - Beta |
| 108 Classifier: Intended Audience :: Developers |
| 109 Classifier: License :: OSI Approved :: Apache Software License |
| 110 Classifier: Programming Language :: Python |
| 111 Classifier: Programming Language :: Python :: 2 |
| 112 Classifier: Programming Language :: Python :: 2.7 |
| 113 Classifier: Programming Language :: Python :: Implementation :: CPython |
OLD | NEW |