diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 654a07164..5bcdb4b5a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,3 +26,14 @@ information on using pull requests. This project follows [Google's Open Source Community Guidelines](https://opensource.google/conduct/). + +## Development environment + +Clone repo locally and install via pip: + +``` +git clone git@github.com:GoogleCloudPlatform/professional-services-data-validator.git +cd professional-services-data-validator/ +python -m pip install --upgrade pip +python -m pip install . +``` diff --git a/README.md b/README.md index 15cf1e867..530be1cb3 100644 --- a/README.md +++ b/README.md @@ -55,19 +55,32 @@ bq mk --table \ The Data Validation tooling requires Python 3.6+. +Create and activate a new virtual environment to sandbox the tool and its +dependencies from your system installation of Python. + +``` +python3.6 -m venv venv +source venv/bin/activate +``` + +Download and install the Python Wheel package file corresponding to the +latest release from +[GitHub](https://github.com/GoogleCloudPlatform/professional-services-data-validator/releases) +or Google Drive. + +``` +python -m pip install ~/Downloads/pso_data_validator-0.1.0-py3-none-any.whl ``` -# Clone repo locally or install via pip -git clone git@github.com:GoogleCloudPlatform/professional-services-data-validator.git -cd professional-services-data-validator/ -python -m pip install --upgrade pip -python -m pip install . -# NOTE: If you require Teradata and have a license. +If you require Teradata and have a license, install the `teradatasql` package. + +``` python -m pip install teradatasql ``` After installing the Data Validation package you will -have access to the `data-validation -h` tool on your CLI. +have access to the `data-validation -h` or `python -m data_validation -h` +tool on your CLI. #### Running CLI Validations diff --git a/RELEASING.md b/RELEASING.md index f397779b1..f96a690e3 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -63,4 +63,5 @@ - Copy the release notes there. - Upload both files from the `dist/` directory. -- Upload to Google Drive (just the `.whl` wheel file). +- Upload the `.whl` wheel file, README, and CHANGELOG to [Google + Drive](https://drive.google.com/corp/drive/folders/1C387pJKyqOCTN0I7sIm0SP6pfHu0PrLG).