Skip to content

docs: readme formatting #4938

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
engelke merged 5 commits into from
Nov 5, 2020
Merged

docs: readme formatting #4938

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d709add
docs: readme formatting
grant Nov 4, 2020
6400a11
docs: fix contributing link
grant Nov 4, 2020
8dd5049
Update README.md
grant Nov 5, 2020
6a87947
Update README.md
grant Nov 5, 2020
d8fa5f1
Merge branch 'master' into grant_readme_touchup
grant Nov 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 60 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,67 @@
## Google Cloud Platform Python Samples
# Google Cloud Platform Python Samples

[![Open in Cloud Shell][shell_img]][shell_link]
Python samples for [Google Cloud Platform products][cloud].

[shell_img]: http://gstatic.com/cloudssh/images/open-btn.png
[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=./README.md
[![Build Status][py-2.7-shield]][py-2.7-link] [![Build Status][py-3.6-shield]][py-3.6-link] [![Build Status][py-3.7-shield]][py-3.7-link] [![Build Status][py-3.8-shield]][py-3.8-link]

This repository holds the samples used in the python documentation on [cloud.google.com](https://cloud.google.com).
## Setup

[![Build Status][py-2.7-shield]][py-2.7-link]
[![Build Status][py-3.6-shield]][py-3.6-link]
[![Build Status][py-3.7-shield]][py-3.7-link]
[![Build Status][py-3.8-shield]][py-3.8-link]
1. Install [`pip` and `virtualenv`][cloud_python_setup] if you do not already have them.

1. Clone this repository:

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

1. Obtain authentication credentials.

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

```
gcloud auth application-default login
```

Read more about [Google Cloud Platform Authentication][gcp_auth].

## How to run a sample

1. Change directory to one of the sample folders, e.g. `logging/cloud-client`:

```
cd logging/cloud-client/
```

1. Create a virtualenv. Samples are compatible with Python 3.6+.
Comment thread
grant marked this conversation as resolved.

```
python3 -m venv env
source env/bin/activate
```

1. Install the dependencies needed to run the samples.

```
pip install -r requirements.txt
```

1. Run the sample:

```
python snippets.py
```

## Contributing

Contributions welcome! See the [Contributing Guide](CONTRIBUTING.md).

[slack_badge]: https://img.shields.io/badge/slack-Google%20Cloud%20Platform-E01563.svg
[slack_link]: https://googlecloud-community.slack.com/
[cloud]: https://cloud.google.com/
[cloud_python_setup]: https://cloud.google.com/python/setup
[auth_command]: https://cloud.google.com/sdk/gcloud/reference/beta/auth/application-default/login
[gcp_auth]: https://cloud.google.com/docs/authentication#projects_and_resources

[py-2.7-shield]: https://storage.googleapis.com/cloud-devrel-public/python-docs-samples/badges/py-2.7.svg
[py-2.7-link]: https://storage.googleapis.com/cloud-devrel-public/python-docs-samples/badges/py-2.7.html
Expand All @@ -20,14 +71,3 @@ This repository holds the samples used in the python documentation on [cloud.goo
[py-3.7-link]: https://storage.googleapis.com/cloud-devrel-public/python-docs-samples/badges/py-3.7.html
[py-3.8-shield]: https://storage.googleapis.com/cloud-devrel-public/python-docs-samples/badges/py-3.8.svg
[py-3.8-link]: https://storage.googleapis.com/cloud-devrel-public/python-docs-samples/badges/py-3.8.html

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

## Contributing changes

* See [CONTRIBUTING.md](CONTRIBUTING.md)

## Licensing

* See [LICENSE](LICENSE)