Skip to content

Commit

Permalink
docs: refresh readme instructions (#667)
Browse files Browse the repository at this point in the history
Update instructions and links in quick start/ samples readme per @cbonnie friction log :)
  • Loading branch information
cojenco committed Dec 16, 2021
1 parent 10cdad6 commit ceb9314
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 23 deletions.
43 changes: 28 additions & 15 deletions README.rst
Expand Up @@ -34,20 +34,22 @@ In order to use this library, you first need to go through the following steps:
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Google Cloud Storage API.: https://cloud.google.com/storage
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
.. _Setup Authentication.: https://cloud.google.com/storage/docs/reference/libraries#setting_up_authentication

Installation
~~~~~~~~~~~~

Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
create isolated Python environments. The basic problem it addresses is one of
dependencies and versions, and indirectly permissions.
`Set up a Python development environment`_ and install this library in a `venv`.
`venv`_ is a tool to create isolated Python environments. The basic problem it
addresses is one of dependencies and versions, and indirectly permissions.

With `virtualenv`_, it's possible to install this library without needing system
Make sure you're using Python 3.3 or later, which includes `venv`_ by default.
With `venv`, it's possible to install this library without needing system
install permissions, and without clashing with the installed system
dependencies.

.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
.. _Set up a Python development environment: https://cloud.google.com/python/docs/setup
.. _`venv`: https://docs.python.org/3/library/venv.html


Supported Python Versions
Expand All @@ -68,30 +70,33 @@ Mac/Linux

.. code-block:: console
pip install virtualenv
virtualenv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-storage
python -m venv env
source env/bin/activate
pip install google-cloud-storage
Windows
^^^^^^^

.. code-block:: console
pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install google-cloud-storage
py -m venv env
.\env\Scripts\activate
pip install google-cloud-storage
Example Usage
~~~~~~~~~~~~~

.. code:: python
# Imports the Google Cloud client library
from google.cloud import storage
# Instantiates a client
client = storage.Client()
# Creates a new bucket and uploads an object
new_bucket = client.create_bucket('new-bucket-id')
new_blob = new_bucket.blob('remote/path/storage.txt')
new_blob.upload_from_filename(filename='/local/path.txt')
Expand All @@ -103,4 +108,12 @@ Example Usage
blob = bucket.get_blob('remote/path/to/file.txt')
print(blob.download_as_bytes())
blob.upload_from_string('New contents!')
What's Next
~~~~~~~~~~~

Now that you've set up your Python client for Cloud Storage,
you can get started running `Storage samples.`_

.. _Storage samples.: https://github.com/googleapis/python-storage/tree/main/samples
13 changes: 5 additions & 8 deletions samples/README.md
Expand Up @@ -21,24 +21,21 @@ Before running the samples, make sure you've followed the steps outlined in
[Quick Start](https://github.com/googleapis/python-storage#quick-start).

### Authentication
This sample requires you to have authentication setup. Refer to the [Authentication Getting Started Guide](https://cloud.google.com/docs/authentication/getting-started)
for instructions on setting up credentials for applications.
Refer to the [Authentication Set Up Guide](https://cloud.google.com/storage/docs/reference/libraries#setting_up_authentication)
for more detailed instructions.

### Install Dependencies
1. Clone this repository and change to the sample directory you want to use.
```
git clone https://github.com/googleapis/python-storage.git
```

2. Install [pip](https://pip.pypa.io/) and [virtualenv](https://virtualenv.pypa.io) if you do not already have them. You may want to refer to the [Python Development Environment Setup Guide](https://cloud.google.com/python/setup) for Google Cloud Platform for instructions.

3. Create a virtualenv. Samples are compatible with Python 3.6+.
2. Activate a venv if you have not already from the [Quick Start](https://github.com/googleapis/python-storage#quick-start).
```
virtualenv env
source env/bin/activate
source <your-venv>/bin/activate
```

4. Install the dependencies needed to run the samples.
3. Install the dependencies needed to run the samples.
```
cd samples/snippets
pip install -r requirements.txt
Expand Down

0 comments on commit ceb9314

Please sign in to comment.