Skip to content

Commit

Permalink
Merge pull request #57 from GoogleCloudPlatform/readme-wheel
Browse files Browse the repository at this point in the history
include installation from wheel file steps in readme
  • Loading branch information
dhercher committed Jul 21, 2020
2 parents f3ddefb + c4f3cf6 commit 6fc20a3
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 8 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]:GoogleCloudPlatform/professional-services-data-validator.git
cd professional-services-data-validator/
python -m pip install --upgrade pip
python -m pip install .
```
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]: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

Expand Down
3 changes: 2 additions & 1 deletion RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

0 comments on commit 6fc20a3

Please sign in to comment.