Skip to content
This repository was archived by the owner on Mar 9, 2026. It is now read-only.

Commit db42645

Browse files
dhermesdhermes
committed
Making pubsub subpackage into a proper package.
- Adding README, setup.py, MANIFEST.in, .coveragerc and tox.ini - Adding google-cloud-pubsub as a dependency to the umbrella package - Adding the pubsub subdirectory into the list of packages for verifying the docs - Incorporating the pubsub subdirectory into the umbrella coverage report - Adding the pubsub only tox tests to the Travis config - Adding {toxinidir}/../core as a dependency for the pubsub tox config
1 parent 84b71fc commit db42645

5 files changed

Lines changed: 178 additions & 0 deletions

File tree

‎.coveragerc‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[run]
2+
branch = True
3+
4+
[report]
5+
fail_under = 100
6+
show_missing = True
7+
exclude_lines =
8+
# Re-enable the standard pragma
9+
pragma: NO COVER
10+
# Ignore debug-only repr
11+
def __repr__

‎MANIFEST.in‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
include README.rst
2+
graft google
3+
graft unit_tests
4+
global-exclude *.pyc

‎README.rst‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
Python Client for Google Cloud Pub / Sub
2+
========================================
3+
4+
Python idiomatic client for `Google Cloud Pub / Sub`_
5+
6+
.. _Google Cloud Pub / Sub: https://cloud.google.com/pubsub/docs
7+
8+
- `Homepage`_
9+
- `API Documentation`_
10+
11+
.. _Homepage: https://googlecloudplatform.github.io/google-cloud-python/
12+
.. _API Documentation: http://googlecloudplatform.github.io/google-cloud-python/
13+
14+
Quick Start
15+
-----------
16+
17+
::
18+
19+
$ pip install --upgrade google-cloud-pubsub
20+
21+
Authentication
22+
--------------
23+
24+
With ``google-cloud-python`` we try to make authentication as painless as
25+
possible. Check out the `Authentication section`_ in our documentation to
26+
learn more. You may also find the `authentication document`_ shared by all
27+
the ``google-cloud-*`` libraries to be helpful.
28+
29+
.. _Authentication section: http://google-cloud-python.readthedocs.io/en/latest/google-cloud-auth.html
30+
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication
31+
32+
Using the API
33+
-------------
34+
35+
Google `Cloud Pub/Sub`_ (`Pub/Sub API docs`_) is designed to provide reliable,
36+
many-to-many, asynchronous messaging between applications. Publisher
37+
applications can send messages to a ``topic`` and other applications can
38+
subscribe to that topic to receive the messages. By decoupling senders and
39+
receivers, Google Cloud Pub/Sub allows developers to communicate between
40+
independently written applications.
41+
42+
.. _Cloud Pub/Sub: https://cloud.google.com/pubsub/docs
43+
.. _Pub/Sub API docs: https://cloud.google.com/pubsub/reference/rest/
44+
45+
See the ``google-cloud-python`` API `Pub/Sub documentation`_ to learn how to connect
46+
to Cloud Pub/Sub using this Client Library.
47+
48+
.. _Pub/Sub documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/pubsub-usage.html
49+
50+
To get started with this API, you'll need to create
51+
52+
.. code:: python
53+
54+
from google.cloud import pubsub
55+
56+
client = pubsub.Client()
57+
topic = client.topic('topic_name')
58+
topic.create()
59+
60+
topic.publish('this is the message_payload',
61+
attr1='value1', attr2='value2')

‎setup.py‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Copyright 2016 Google Inc.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
import os
16+
17+
from setuptools import find_packages
18+
from setuptools import setup
19+
20+
21+
PACKAGE_ROOT = os.path.abspath(os.path.dirname(__file__))
22+
23+
with open(os.path.join(PACKAGE_ROOT, 'README.rst')) as file_obj:
24+
README = file_obj.read()
25+
26+
# NOTE: This is duplicated throughout and we should try to
27+
# consolidate.
28+
SETUP_BASE = {
29+
'author': 'Google Cloud Platform',
30+
'author_email': 'jjg+google-cloud-python@google.com',
31+
'scripts': [],
32+
'url': 'https://github.com/GoogleCloudPlatform/google-cloud-python',
33+
'license': 'Apache 2.0',
34+
'platforms': 'Posix; MacOS X; Windows',
35+
'include_package_data': True,
36+
'zip_safe': False,
37+
'classifiers': [
38+
'Development Status :: 4 - Beta',
39+
'Intended Audience :: Developers',
40+
'License :: OSI Approved :: Apache Software License',
41+
'Operating System :: OS Independent',
42+
'Programming Language :: Python :: 2',
43+
'Programming Language :: Python :: 2.7',
44+
'Programming Language :: Python :: 3',
45+
'Programming Language :: Python :: 3.4',
46+
'Programming Language :: Python :: 3.5',
47+
'Topic :: Internet',
48+
],
49+
}
50+
51+
52+
REQUIREMENTS = [
53+
'google-cloud-core',
54+
'grpcio >= 1.0.0',
55+
'google-gax >= 0.14.1, < 0.15dev',
56+
'gapic-google-pubsub-v1 >= 0.9.0, < 0.10dev',
57+
'grpc-google-pubsub-v1 >= 0.9.0, < 0.10dev',
58+
]
59+
60+
setup(
61+
name='google-cloud-pubsub',
62+
version='0.20.0dev',
63+
description='Python Client for Google Cloud Pub/Sub',
64+
long_description=README,
65+
namespace_packages=[
66+
'google',
67+
'google.cloud',
68+
],
69+
packages=find_packages(),
70+
install_requires=REQUIREMENTS,
71+
**SETUP_BASE
72+
)

‎tox.ini‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
[tox]
2+
envlist =
3+
py27,py34,py35,cover
4+
5+
[testing]
6+
deps =
7+
{toxinidir}/../core
8+
pytest
9+
covercmd =
10+
py.test --quiet \
11+
--cov=google.cloud.pubsub \
12+
--cov=unit_tests \
13+
--cov-config {toxinidir}/.coveragerc \
14+
unit_tests
15+
16+
[testenv]
17+
commands =
18+
py.test --quiet {posargs} unit_tests
19+
deps =
20+
{[testing]deps}
21+
22+
[testenv:cover]
23+
basepython =
24+
python2.7
25+
commands =
26+
{[testing]covercmd}
27+
deps =
28+
{[testenv]deps}
29+
coverage
30+
pytest-cov

0 commit comments

Comments
 (0)