chore: Update CONTRIBUTING (#154)

Author: kurtisvg

CONTRIBUTING.md

@@ -15,14 +15,57 @@ You generally only need to submit a CLA once, so if you've already submitted one
 (even if it was for a different project), you probably don't need to do it
 again.
 
+## Community Guidelines
+
+This project follows
+[Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).
+
 ## Code reviews
 
 All submissions, including submissions by project members, require review. We
 use GitHub pull requests for this purpose. Consult
 [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
 information on using pull requests.
 
-## Community Guidelines
+## Running tests
 
-This project follows
-[Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).
+### Initial Setup
+
+1. Enable the SQL Admin API.
+2. This library uses [Application Default Credentials (ADC)][adc]] to 
+  automatically detect credentials. Which ever credential you use must have the
+  Cloud SQL client role (or equivalent permissions). 
+3. You'll need to create several Cloud SQL instances - one for MySQL, Postgres,
+  and SQL Server. 
+2. Once created, set the following environment variables:
+```
+export MYSQL_CONNECTION_NAME="your:connection:string"
+export MYSQL_USER="db_user"
+export MYSQL_PASS="db_pass"
+export MYSQL_DB="db_name"
+
+export POSTGRES_CONNECTION_NAME="your:connection:string"
+export POSTGRES_USER="db_user"
+export POSTGRES_PASS="db_pass"
+export POSTGRES_DB="db_name"
+
+# This instance will need to have IAM Database authentication enabled
+export POSTGRES_IAM_CONNECTION_NAME="your:connection:string"
+export POSTGRES_IAM_USER="[email protected]"
+
+export SQLSERVER_CONNECTION_NAME="your:connection:string"
+export SQLSERVER_USER="db_user"
+export SQLSERVER_PASS="db_pass"
+export SQLSERVER_DB="db_name"
+```
+
+### Running tests 
+
+Tests can be run with `nox`. You can install nox with `pip install nox`, and
+run specific tests with `nox -s $SESSION_NAME`.
+
+Note: You may need a specific version of python installed to run those tests.
+For example, you'll need Python 3.8 installed to run `unit-3.8` or 
+`system-3.8`.
+
+[adc]: https://cloud.google.com/docs/authentication/best-practices-applications#overview_of_application_default_credentials

README.md

@@ -173,24 +173,7 @@ This project aims for a minimum monthly release cadence. If no new
 features or fixes have been added, a new PATCH version with the latest
 dependencies is released.
 
-### Setup for development
+### Contributing
 
-Tests can be run with `nox`. Change directory into the `cloud-sql-python-connector` and just run `nox` to run the tests.
-
-1. Create a MySQL instance on Google Cloud SQL. Make sure to note your root password when creating the MySQL instance.
-2. When the MySQL instance has finished creating, go to the overview page and set the instance’s connection string to the environment variable MYSQL_CONNECTION_NAME using the following command:
-```
-export MYSQL_CONNECTION_NAME=your:connection:string
-```
-3. Enable SSL for your Cloud SQL instance by following [these instructions](https://cloud.google.com/sql/docs/mysql/configure-ssl-instance).
-4. Create a service account with Cloud SQL Admin and Cloud SQL Client roles, then download the key and save it in a safe location. Set the path to the json file to the environment variable GOOGLE_APPLICATION_CREDENTIALS using the following command:
-```
-export GOOGLE_APPLICATION_CREDENTIALS=/path/to/auth/./json
-```
-5. Enable the SQL Admin API.
-6. Clone the [repository](https://github.com/GoogleCloudPlatform/cloud-sql-python-connector).
-7. Create a virtual environment and change directory into the `cloud-sql-python-connector` folder.
-8. Install the package by running the following command:
-```
-pip install .
-```
+We welcome outside contributions. Please see our 
+[Contributing Guide](CONTRIBUTING.md) for details on how best to contribute. 

noxfile.py

@@ -26,7 +26,7 @@
 if os.path.exists("samples"):
     BLACK_PATHS.append("samples")
 
-@nox.session(python="3.7")
+@nox.session
 def lint(session):
     """Run linters.
     Returns a failure if the linters find linting errors or sufficiently
@@ -43,7 +43,7 @@ def lint(session):
     session.run("twine", "check", "dist/*")
 
 
-@nox.session(python="3.6")
+@nox.session
 def blacken(session):
     """Run black.
     Format code to uniform standard.