Skip to content

Commit d58a53a

Browse files
committed
docs: update README, CONTRIBUTING and LICENSE, remove CONTRIB
1 parent e30de64 commit d58a53a

File tree

4 files changed

+92
-78
lines changed

4 files changed

+92
-78
lines changed

CONTRIB.rst

Lines changed: 0 additions & 25 deletions
This file was deleted.

CONTRIBUTING.rst

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1-
Hacking on ``gcloud-python``
1+
Contributing
22
============================
33

4+
#. **Please sign one of the contributor license agreements below.**
5+
#. Fork the repo, develop and test your code changes, add docs.
6+
#. Make sure that your commit messages clearly describe the changes.
7+
#. Send a pull request.
8+
49
Here are some guidelines for hacking on gcloud-python.
510

611
Using a Development Checkout
@@ -155,10 +160,12 @@ can build the docs via::
155160

156161
$ tox -e docs
157162

158-
Change Log
159-
----------
163+
Contributor License Agreements
164+
------------------------------
165+
166+
Before we can accept your pull requests you'll need to sign a Contributor License Agreement (CLA):
167+
168+
- **If you are an individual writing original source code** and **you own the intellectual property**, then you'll need to sign an `individual CLA <https://developers.google.com/open-source/cla/individual>`__.
169+
- **If you work for a company that wants to allow you to contribute your work**, then you'll need to sign a `corporate CLA <https://developers.google.com/open-source/cla/corporate>`__.
160170

161-
- Feature additions and bugfixes must be added to the ``CHANGES.txt``
162-
file in the prevailing style. Changelog entries should be long and
163-
descriptive, not cryptic. Other developers should be able to know
164-
what your changelog entry means.
171+
You can sign these electronically (just scroll to the bottom). After that, we'll be able to accept your pull requests.

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ Apache License
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright {yyyy} {name of copyright owner}
189+
Copyright 2014 Google Inc.
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

README.rst

Lines changed: 77 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,30 @@
11
Google Cloud Python Client
22
==========================
33

4-
The goal of this project is to make it really simple and Pythonic
5-
to use Google Cloud Platform services.
4+
Python idiomatic client for Google Cloud Platform services.
65

7-
------------------
86
|build| |coverage|
97
------------------
108

11-
Quickstart
12-
----------
9+
- `Homepage <https://googlecloudplatform.github.io/gcloud-python/>`__
1310

14-
The library is ``pip``-installable::
11+
This client supports the following Google Cloud Platform services:
1512

16-
$ pip install gcloud
17-
$ python -m gcloud.storage.demo # Runs the storage demo!
13+
- `Google Cloud
14+
Datastore <https://cloud.google.com/products/cloud-datastore/>`__
15+
- `Google Cloud
16+
Storage <https://cloud.google.com/products/cloud-storage/>`__
17+
18+
If you need support for other Google APIs, check out the `Google APIs
19+
Python Client
20+
library <https://github.com/google/google-api-python-client>`__.
21+
22+
Quickstart
23+
----------
1824

19-
Documentation
20-
-------------
25+
::
2126

22-
- `gcloud docs (browse all services, quick-starts, walk-throughs) <http://GoogleCloudPlatform.github.io/gcloud-python/>`_
23-
- `gcloud.datastore API docs <http://googlecloudplatform.github.io/gcloud-python/datastore-api.html>`_
24-
- `gcloud.storage API docs <http://googlecloudplatform.github.io/gcloud-python/storage-api.html>`_
25-
- gcloud.bigquery API docs (*coming soon)*
26-
- gcloud.compute API docs *(coming soon)*
27-
- gcloud.dns API docs *(coming soon)*
28-
- gcloud.sql API docs *(coming soon)*
27+
$ pip install gcloud
2928

3029
I'm getting weird errors... Can you help?
3130
-----------------------------------------
@@ -43,43 +42,76 @@ and then ``pip install`` the dependencies again::
4342
$ sudo apt-get install python-dev libssl-dev libffi-dev
4443
$ pip install gcloud
4544

46-
How do I build the docs?
47-
------------------------
45+
Google Cloud Datastore
46+
----------------------
47+
48+
`Google Cloud Datastore <https://developers.google.com/datastore/>`__ is
49+
a fully managed, schemaless database for storing non-relational data.
50+
Cloud Datastore automatically scales with your users and supports ACID
51+
transactions, high availability of reads and writes, strong consistency
52+
for reads and ancestor queries, and eventual consistency for all other
53+
queries.
54+
55+
See the `Google Cloud Datastore
56+
docs <https://developers.google.com/datastore/docs/activate>`__ for more
57+
details on how to activate Cloud Datastore for your project.
58+
59+
See `the gcloud-python API
60+
documentation <https://googlecloudplatform.github.io/gcloud-python/datastore-api.html>`__
61+
to learn how to interact with the Cloud Datastore using this Client
62+
Library.
63+
64+
.. code:: python
65+
66+
from gcloud import datastore
67+
dataset = datastore.get_dataset('dataset-id-here',
68+
69+
'/path/to/private.key')
70+
# Then do other things...
71+
query = dataset.query().kind('EntityKind')
72+
entity = dataset.entity('EntityKind')
73+
74+
Google Cloud Storage
75+
--------------------
76+
77+
`Google Cloud Storage <https://developers.google.com/storage/>`__ allows
78+
you to store data on Google infrastructure with very high reliability,
79+
performance and availability, and can be used to distribute large data
80+
objects to users via direct download.
4881

49-
Make sure you have ``sphinx`` installed and::
82+
You need to create a Google Cloud Storage bucket to use this client
83+
library. Follow the steps on the `Google Cloud Storage
84+
docs <https://developers.google.com/storage/docs/cloud-console#_creatingbuckets>`__
85+
to learn how to create a bucket.
5086

51-
$ git clone git://github.com/GoogleCloudPlatform/gcloud-python.git
52-
$ pip install sphinx
53-
$ cd gcloud-python/docs
54-
$ make html
87+
See `the gcloud-python API
88+
documentation <https://googlecloudplatform.github.io/gcloud-python/storage-api.html>`__
89+
to learn how to connect to the Cloud Storage using this Client Library.
5590

56-
How do I run the tests?
57-
-----------------------
91+
.. code:: python
5892
59-
Make sure you have ``nose`` installed and::
93+
import gcloud.storage
94+
bucket = gcloud.storage.get_bucket('bucket-id-here',
95+
96+
'/path/to/private.key')
97+
# Then do other things...
98+
key = bucket.get_key('/remote/path/to/file.txt')
99+
print key.get_contents_as_string()
100+
key.set_contents_from_string('New contents!')
101+
bucket.upload_file('/remote/path/storage.txt', '/local/path.txt')
60102
61-
$ git clone git://github.com/GoogleCloudPlatform/gcloud-python.git
62-
$ pip install unittest2 nose
63-
$ cd gcloud-python
64-
$ nosetests
103+
Contributing
104+
------------
65105

66-
How can I contribute?
67-
---------------------
106+
Contributions to this library are always welcome and highly encouraged.
68107

69-
Before we can accept any pull requests
70-
we have to jump through a couple of legal hurdles,
71-
primarily a Contributor License Agreement (CLA):
108+
See `CONTRIBUTING <CONTRIBUTING.rst>`__ for more information on how to
109+
get started.
72110

73-
- **If you are an individual writing original source code**
74-
and you're sure you own the intellectual property,
75-
then you'll need to sign an `individual CLA
76-
<http://code.google.com/legal/individual-cla-v1.0.html>`_.
77-
- **If you work for a company that wants to allow you to contribute your work**,
78-
then you'll need to sign a `corporate CLA
79-
<http://code.google.com/legal/corporate-cla-v1.0.html>`_.
111+
License
112+
-------
80113

81-
You can sign these electronically (just scroll to the bottom).
82-
After that, we'll be able to accept your pull requests.
114+
Apache 2.0 - See `LICENSE <LICENSE>`__ for more information.
83115

84116
.. |build| image:: https://travis-ci.org/GoogleCloudPlatform/gcloud-python.svg?branch=master
85117
:target: https://travis-ci.org/GoogleCloudPlatform/gcloud-python

0 commit comments

Comments
 (0)