@@ -6,42 +6,42 @@ Contributing
66#. Make sure that your commit messages clearly describe the changes.
77#. Send a pull request.
88
9- Here are some guidelines for hacking on ``gcloud -python ``.
9+ Here are some guidelines for hacking on ``google-cloud -python ``.
1010
1111Using a Development Checkout
1212----------------------------
1313
14- You'll have to create a development environment to hack on ``gcloud -python ``,
14+ You'll have to create a development environment to hack on ``google-cloud -python ``,
1515using a Git checkout:
1616
17- - While logged into your GitHub account, navigate to the ``gcloud -python `` repo
17+ - While logged into your GitHub account, navigate to the ``google-cloud -python `` repo
1818 on GitHub.
1919
20- https://github.com/GoogleCloudPlatform/gcloud -python
20+ https://github.com/GoogleCloudPlatform/google-cloud -python
2121
22- - Fork and clone the ``gcloud -python `` repository to your GitHub account by
22+ - Fork and clone the ``google-cloud -python `` repository to your GitHub account by
2323 clicking the "Fork" button.
2424
25- - Clone your fork of ``gcloud -python `` from your GitHub account to your local
25+ - Clone your fork of ``google-cloud -python `` from your GitHub account to your local
2626 computer, substituting your account username and specifying the destination
27- as "hack-on-gcloud ". E.g.::
27+ as "hack-on-google-cloud-python ". E.g.::
2828
2929 $ cd ~
30- $ git clone git@github.com:USERNAME/gcloud- python.git hack-on-gcloud
31- $ cd hack-on-gcloud
32- # Configure remotes such that you can pull changes from the gcloud -python
30+ $ git clone git@github.com:USERNAME/google-cloud- python.git hack-on-google-cloud-python
31+ $ cd hack-on-google-cloud-python
32+ # Configure remotes such that you can pull changes from the google-cloud -python
3333 # repository into your local repository.
34- $ git remote add upstream https://github.com:GoogleCloudPlatform/gcloud -python
34+ $ git remote add upstream https://github.com:GoogleCloudPlatform/google-cloud -python
3535 # fetch and merge changes from upstream into master
3636 $ git fetch upstream
3737 $ git merge upstream/master
3838
3939Now your local repo is set up such that you will push changes to your GitHub
4040repo, from which you can submit a pull request.
4141
42- - Create a virtualenv in which to install ``gcloud -python ``::
42+ - Create a virtualenv in which to install ``google-cloud -python ``::
4343
44- $ cd ~/hack-on-gcloud
44+ $ cd ~/hack-on-google-cloud-python
4545 $ virtualenv --python python2.7 env
4646
4747 Note that very old versions of virtualenv (virtualenv versions below, say,
@@ -52,16 +52,16 @@ repo, from which you can submit a pull request.
5252 flag to ``virtualenv``. For example, ``virtualenv --python python2.7``
5353 chooses the Python 2.7 interpreter to be installed.
5454
55- From here on in within these instructions, the ``~/hack-on-gcloud /env``
55+ From here on in within these instructions, the ``~/hack-on-google-cloud-python /env``
5656 virtual environment you created above will be referred to as ``$VENV``.
5757 To use the instructions in the steps that follow literally, use the
58- ``export VENV=~/hack-on-gcloud /env`` command.
58+ ``export VENV=~/hack-on-google-cloud-python /env`` command.
5959
60- - Install ``gcloud -python `` from the checkout into the virtualenv using
60+ - Install ``google-cloud -python `` from the checkout into the virtualenv using
6161 ``setup.py develop ``. Running ``setup.py develop `` *must * be done while
62- the current working directory is the ``gcloud -python `` checkout directory::
62+ the current working directory is the ``google-cloud -python `` checkout directory::
6363
64- $ cd ~/hack-on-gcloud
64+ $ cd ~/hack-on-google-cloud-python
6565 $ $VENV/bin/python setup.py develop
6666
6767I'm getting weird errors... Can you help?
@@ -76,7 +76,7 @@ On Debian/Ubuntu::
7676Adding Features
7777---------------
7878
79- In order to add a feature to ``gcloud -python ``:
79+ In order to add a feature to ``google-cloud -python ``:
8080
8181- The feature must be documented in both the API and narrative
8282 documentation (in ``docs/ ``).
@@ -100,11 +100,11 @@ Coding Style
100100- In order to make ``tox -e lint `` run faster, you can set some environment
101101 variables::
102102
103- export GCLOUD_REMOTE_FOR_LINT ="upstream"
104- export GCLOUD_BRANCH_FOR_LINT ="master"
103+ export GOOGLE_CLOUD_REMOTE_FOR_LINT ="upstream"
104+ export GOOGLE_CLOUD_BRANCH_FOR_LINT ="master"
105105
106106 By doing this, you are specifying the location of the most up-to-date
107- version of ``gcloud -python ``. The the suggested remote name ``upstream ``
107+ version of ``google-cloud -python ``. The the suggested remote name ``upstream ``
108108 should point to the official ``GoogleCloudPlatform `` checkout and the
109109 the branch should be the main branch on that remote (``master ``).
110110
@@ -117,21 +117,21 @@ Exceptions to PEP8:
117117Running Tests
118118--------------
119119
120- - To run all tests for ``gcloud -python `` on a single Python version, run
120+ - To run all tests for ``google-cloud -python `` on a single Python version, run
121121 ``py.test `` from your development virtualenv (See
122122 *Using a Development Checkout * above).
123123
124- - To run the full set of ``gcloud -python `` tests on all platforms, install
124+ - To run the full set of ``google-cloud -python `` tests on all platforms, install
125125 ``tox `` (https://testrun.org/tox/) into a system Python. The ``tox `` console
126126 script will be installed into the scripts location for that Python. While
127- ``cd ``'ed to the ``gcloud -python `` checkout root directory (it contains
127+ ``cd ``'ed to the ``google-cloud -python `` checkout root directory (it contains
128128 ``tox.ini ``), invoke the ``tox `` console script. This will read the
129129 ``tox.ini `` file and execute the tests on multiple Python versions and
130130 platforms; while it runs, it creates a virtualenv for each version/platform
131131 combination. For example::
132132
133133 $ sudo /usr/bin/pip install tox
134- $ cd ~/hack-on-gcloud /
134+ $ cd ~/hack-on-google-cloud-python /
135135 $ /usr/bin/tox
136136
137137Running System Tests
@@ -153,7 +153,7 @@ Running System Tests
153153 so you'll need to provide some environment variables to facilitate
154154 authentication to your project:
155155
156- - ``GCLOUD_TESTS_PROJECT_ID ``: Developers Console project ID (e.g.
156+ - ``GOOGLE_CLOUD_TESTS_PROJECT_ID ``: Developers Console project ID (e.g.
157157 bamboo-shift-455).
158158 - ``GOOGLE_APPLICATION_CREDENTIALS ``: The path to a JSON key file;
159159 see ``system_tests/app_credentials.json.sample `` as an example. Such a file
@@ -187,7 +187,7 @@ Running System Tests
187187
188188 # Create the indexes
189189 $ gcloud preview datastore create-indexes system_tests/data/index.yaml \
190- > --project=$GCLOUD_TESTS_PROJECT_ID
190+ > --project=$GOOGLE_CLOUD_TESTS_PROJECT_ID
191191
192192 # Restore your environment to its previous state.
193193 $ unset CLOUDSDK_PYTHON_SITEPACKAGES
@@ -223,14 +223,14 @@ Running System Tests
223223 $ gcloud beta emulators datastore env-init
224224 export DATASTORE_LOCAL_HOST=localhost:8417
225225 export DATASTORE_HOST=http://localhost:8417
226- export DATASTORE_DATASET=gcloud -settings-app-id
227- export DATASTORE_PROJECT_ID=gcloud -settings-app-id
226+ export DATASTORE_DATASET=google-cloud -settings-app-id
227+ export DATASTORE_PROJECT_ID=google-cloud -settings-app-id
228228
229229 using these environment variables run the emulator::
230230
231231 $ DATASTORE_HOST=http://localhost:8471 \
232- > DATASTORE_DATASET=gcloud -settings-app-id \
233- > GCLOUD_NO_PRINT =true \
232+ > DATASTORE_DATASET=google-cloud -settings-app-id \
233+ > GOOGLE_CLOUD_NO_PRINT =true \
234234 > python system_tests/run_system_test.py \
235235 > --package=datastore --ignore-requirements
236236
@@ -283,22 +283,22 @@ changed to reflect the bug fix, ideally in the same commit that fixes the bug
283283or adds the feature.
284284
285285To build and review docs (where ``$VENV `` refers to the virtualenv you're
286- using to develop ``gcloud -python ``):
286+ using to develop ``google-cloud -python ``):
287287
2882881. After following the steps above in "Using a Development Checkout", install
289289 Sphinx and all development requirements in your virtualenv::
290290
291- $ cd ~/hack-on-gcloud
291+ $ cd ~/hack-on-google-cloud-python
292292 $ $VENV/bin/pip install Sphinx
293293
294- 2. Change into the ``docs `` directory within your ``gcloud -python `` checkout and
294+ 2. Change into the ``docs `` directory within your ``google-cloud -python `` checkout and
295295 execute the ``make `` command with some flags::
296296
297- $ cd ~/hack-on-gcloud/gcloud -python/docs
297+ $ cd ~/hack-on-google-cloud-python/google-cloud -python/docs
298298 $ make clean html SPHINXBUILD=$VENV/bin/sphinx-build
299299
300300 The ``SPHINXBUILD=... `` argument tells Sphinx to use the virtualenv Python,
301- which will have both Sphinx and ``gcloud -python `` (for API documentation
301+ which will have both Sphinx and ``google-cloud -python `` (for API documentation
302302 generation) installed.
303303
3043043. Open the ``docs/_build/html/index.html `` file to see the resulting HTML
@@ -314,7 +314,7 @@ build via::
314314
315315 $ tox -e docs-rtd
316316
317- .. _readthedocs : http://gcloud -python.readthedocs.org/
317+ .. _readthedocs : http://google-cloud -python.readthedocs.org/
318318
319319Note About ``README `` as it pertains to PyPI
320320--------------------------------------------
@@ -323,10 +323,10 @@ The `description on PyPI`_ for the project comes directly from the
323323``README ``. Due to the reStructuredText (``rst ``) parser used by
324324PyPI, relative links which will work on GitHub (e.g. ``CONTRIBUTING.rst ``
325325instead of
326- ``https://github.com/GoogleCloudPlatform/gcloud -python/blob/master/CONTRIBUTING.rst ``)
326+ ``https://github.com/GoogleCloudPlatform/google-cloud -python/blob/master/CONTRIBUTING.rst ``)
327327may cause problems creating links or rendering the description.
328328
329- .. _description on PyPI : https://pypi.python.org/pypi/gcloud
329+ .. _description on PyPI : https://pypi.python.org/pypi/google-cloud
330330
331331Travis Configuration and Build Optimizations
332332--------------------------------------------
@@ -364,7 +364,7 @@ We support:
364364
365365Supported versions can be found in our ``tox.ini `` `config `_.
366366
367- .. _config : https://github.com/GoogleCloudPlatform/gcloud -python/blob/master/tox.ini
367+ .. _config : https://github.com/GoogleCloudPlatform/google-cloud -python/blob/master/tox.ini
368368
369369We explicitly decided not to support `Python 2.5 `_ due to `decreased usage `_
370370and lack of continuous integration `support `_.
@@ -387,7 +387,7 @@ We also explicitly decided to support Python 3 beginning with version
387387.. _prominent : https://docs.djangoproject.com/en/1.9/faq/install/#what-python-version-can-i-use-with-django
388388.. _projects : http://flask.pocoo.org/docs/0.10/python3/
389389.. _Unicode literal support : https://www.python.org/dev/peps/pep-0414/
390- .. _dropped 2.6 : https://github.com/GoogleCloudPlatform/gcloud -python/issues/995
390+ .. _dropped 2.6 : https://github.com/GoogleCloudPlatform/google-cloud -python/issues/995
391391
392392Versioning
393393----------
0 commit comments