Skip to content
Permalink
Browse files
docs: change descriptions for virtual environment (#48)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [X] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/python-logging/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
- [X] Ensure the tests and linter pass
- [X] Code coverage does not decrease (if any source code was changed)
- [X] Appropriate docs were updated (if necessary)

Fixes #47
  • Loading branch information
ymotongpoo committed Jul 1, 2020
1 parent 6dde25e commit c5c3c153d1ae91f44c4104279baae9d9e4f88d03
Showing with 7 additions and 9 deletions.
  1. +7 −9 README.rst
@@ -1,7 +1,7 @@
Python Client for Stackdriver Logging
=====================================

|pypi| |versions|
|pypi| |versions|

`Stackdriver Logging API`_: Writes log entries and manages your Stackdriver
Logging configuration.
@@ -35,15 +35,15 @@ In order to use this library, you first need to go through the following steps:
Installation
~~~~~~~~~~~~

Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
Install this library in a `venv`_ using pip. `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
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/
.. _`venv`: https://docs.python.org/3/library/venv.html


Supported Python Versions
@@ -52,16 +52,15 @@ Python >= 3.5

Deprecated Python Versions
^^^^^^^^^^^^^^^^^^^^^^^^^^
Python == 2.7. Python 2.7 support will be removed on January 1, 2020.
Python == 2.7. Python 2.7 support was removed on January 1, 2020.


Mac/Linux
^^^^^^^^^

.. code-block:: console

pip install virtualenv
virtualenv <your-env>
python -m venv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-logging

@@ -71,8 +70,7 @@ Windows

.. code-block:: console

pip install virtualenv
virtualenv <your-env>
python -m venv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install google-cloud-logging

0 comments on commit c5c3c15

Please sign in to comment.