release 0.1.0 (#55)

CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+## 0.1.0 (2020-07-16)
+
+Initial alpha release.
+
+### New Features
+
+- Add `data-validation` CLI, which can `run` from CLI arguments, `store` a
+  configuration YAML file, or run from a `run-config` YAML file.
+- Add support for querying Teradata.
+- Add support for querying BigQuery.
+- Write report output to BigQuery.
+
+### Dependencies
+
+- To use Teradata support, you must manually install the `teradatasql` PIP
+  package.
+
+### Documentation
+
+- See the `README.md` file for getting started instructions.

RELEASING.md

@@ -0,0 +1,66 @@
+# Release steps
+
+## Prepare a release
+
+- Update [CHANGELOG.md](CHANGELOG.md) based on git commit history since last
+  release.
+- Update the version string in [setup.py](setup.py).
+- Send a pull request with your changes.
+
+## Build a package
+
+- After the PR is merged, checkout the main `develop` branch.
+
+  ```
+  git fetch upstream develop
+  git checkout develop
+  git rebase -i upstream/develop
+  ```
+
+- Remove any temporary files leftover from previous builds.
+
+  ```
+  git clean -xfd
+  ```
+
+- Build the package.
+
+  ```
+  python setup.py register sdist bdist_wheel
+  ```
+
+## Test the package
+
+- Create a fresh venv.
+- Install the package from the `dist/` directory.
+
+  ```
+  pip install ./dist/google_pso_data_validator-X.X.X-py3-none-any.whl
+  ```
+
+- Check that the command-line runs.
+
+  ```
+  data-validation -h
+  ```
+
+## Publish the package
+
+- Tag the release.
+
+  ```
+  git tag -a x.x.x -m 'Version x.x.x'
+  ```
+
+- Push the tag to GitHub.
+
+  ```
+  git push upstream develop --tags
+  ```
+
+- Find the tag in the [GitHub
+  releases](https://github.com/GoogleCloudPlatform/professional-services-data-validator/releases).
+  - Copy the release notes there.
+  - Upload both files from the `dist/` directory.
+
+- Upload to Google Drive (just the `.whl` wheel file).

setup.py

@@ -16,13 +16,17 @@
 
 import setuptools
 
+name = 'google-pso-data-validator'
+description = "A package to enable easy data validation"
+version = '0.1.0'
+release_status = 'Development Status :: 3 - Alpha'
 
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
-install_requires = open("requirements.txt").read().strip().split("\n")
-install_requires = [
-    v for v in install_requires if not v.startswith("#")
+dependencies = open("requirements.txt").read().strip().split("\n")
+dependencies = [
+    v for v in dependencies if not v.startswith("#")
 ]  # Remove comments
 
 packages = [
@@ -37,22 +41,24 @@
 ]
 
 setuptools.setup(
-    name="google-pso-data-validator",
-    version="0.0.1",
+    name=name,
+    description=description,
+    version=version,
     author="Dylan Hercher",
     author_email="[email protected]",
-    description="A package to enable easy data validation",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/pypa/sampleproject",
     packages=packages,
     classifiers=[
-        "Programming Language :: Python :: 3",
-        "License :: OSI Approved :: MIT License",
+        release_status,
+        'License :: OSI Approved :: Apache Software License',
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3.6",
         "Operating System :: OS Independent",
     ],
     python_requires=">=3.6",
-    install_requires=install_requires,
+    install_requires=dependencies,
     entry_points={
         "console_scripts": ["data-validation=data_validation.__main__:main",]
     },