In which file did you encounter the issue?

README.md

Did you change the file? If so, how?

No

Describe the issue

It would be cool if this repo had a slightly better main README experience. I think Node has an ideal experience, ruby is also slightly better. This would include:

• H1 for repo title
• Organization of badges (under repo title)
• Smaller Cloud Shell button
• Generic setup instructions (like Node)
  • (Or like the functions/ directory)
  • Prereqs
    • List prereqs
    • Clone the repo
    • Obtain auth creds
  • How to run a sample
    • Change to a directory in one of the sample folders
    • Create a virtualenv
    • Install the dependencies needed to run the samples
    • Run the sample

This could also reduce the duplicated instructions we have in specific folders.

In addition to these additive instructions, we could remove links to standard GitHub repo files

• Contributing changes is in CONTRIBUTING.md
• Licensing is in LICENSE

GitHub and modern git tools automatically detect these files. It's not necessary for projects to add links to them in the README.

CURRENT

Google Cloud Platform Python Samples

This repository holds the samples used in the python documentation on cloud.google.com.

For a more detailed introduction to a product, check the README.md in the
corresponding folder.

Contributing changes

• See CONTRIBUTING.md

Licensing

• See LICENSE

SUGGESTED

Google Cloud Platform Python Samples

Python samples for Google Cloud Platform products.

Setup

1. Install pip and virtualenv if you do not already have them.

2. Clone this repository:

    git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
   

3. Obtain authentication credentials.

   Create local credentials by running the following command and following the
   oauth2 flow (read more about the command here):

    gcloud auth application-default login
   

   Read more about Google Cloud Platform Authentication.

How to run a sample

1. Change directory to one of the sample folders, e.g. language:

    cd language/
   

2. Create a virtualenv. Samples are compatible with Python 2.7 and 3.4+.

   virtualenv env
   source env/bin/activate
   

3. Install the dependencies needed to run the samples.

   pip install -r requirements.txt
   

4. Run the sample:

   python snippets