Google Cloud Storage Python Samples

This directory contains samples for Google Cloud Storage. Cloud Storage allows world-wide storage and retrieval of any amount of data at any time. You can use Google Cloud Storage for a range of scenarios including serving website content, storing data for archival and disaster recovery, or distributing large data objects to users via direct download.

Setup

Before you begin

Before running the samples, make sure you've followed the steps outlined in Quick Start.

Authentication

Refer to the Authentication Set Up Guide for more detailed instructions.

Install Dependencies

Clone this repository and change to the sample directory you want to use.
```
git clone https://github.com/googleapis/python-storage.git
```
Activate a venv if you have not already from the Quick Start.
```
source <your-venv>/bin/activate
```

Install the dependencies needed to run the samples.

cd samples/snippets
pip install -r requirements.txt

Running tests locally

Before running the tests, make sure you've followed the steps outlined in Setup.

Install nox

We use nox to instrument our tests.

pip install nox

Set environment variables

You can run tests locally using your own gcs project or with a valid service account in project python-docs-samples-tests. This outlines the workflow of running tests locally using your own gcs project.

Refer to noxfile_config.py and a list of environment variables that can be set manually. Not every test needs all of these variables. Below outlines some common environment variables used in the storage samples. See Other Resources on how to create credentials, keys, and secrets.

export GOOGLE_CLOUD_PROJECT=[your-project-name]
export MAIN_GOOGLE_CLOUD_PROJECT=[your-project-name]
export BUILD_SPECIFIC_GCLOUD_PROJECT=[your-project-name]
export HMAC_KEY_TEST_SERVICE_ACCOUNT=[your-service-account]
export CLOUD_KMS_KEY=[your-kms-key]
export GOOGLE_APPLICATION_CREDENTIALS=[your-credentials]

If you are running a single test locally that does not use the environment variables, you can delete the noxfile_config.py file and simply set your GOOGLE_CLOUD_PROJECT

export GOOGLE_CLOUD_PROJECT=[your-project-name]

Run tests with nox

nox -s lint
nox -s py-3.9 -- snippets_test.py
nox -s py-3.9 -- snippets_test.py::test_list_blobs

Special test configurations

There are restrictions on the testing projects used in Kokoro. For instance, we change the service account based on different test sessions to avoid hitting the maximum limit of HMAC keys on a single service account. Another example is requester_pays_test.py needs to use a different Storage bucket, and looks for an environment variable REQUESTER_PAYS_TEST_BUCKET. Please refer to noxfile_config.py , kokoro configs, and test files to see if there are special test configurations required.

Other Resources