Add testing workflow and update contributing guide (#259)

Author: codesue

.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on:
+  push:
+    paths:
+      - 'model_card_toolkit/**'
+      - '.github/workflows/ci.yml'
+      - 'setup.py'
+      - 'pyproject.toml'
+    branches:
+      - master
+      - r*
+  pull_request:
+    paths:
+      - 'model_card_toolkit/**'
+      - '.github/workflows/ci.yml'
+      - 'setup.py'
+      - 'pyproject.toml'
+    branches:
+      - master
+      - r*
+
+concurrency: 
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.7
+    - name: Cache python environment
+      uses: actions/cache@v2
+      with:
+        # Cache pip
+        path: ~/.cache/pip
+        # Check the cache for a given setup.py + MCT version
+        key: ${{ runner.os }}-pip-${{ hashFiles('model_card_toolkit/version.py') }}
+        restore-keys: |
+          ${{ runner.os }}-pip
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip wheel
+        python -m pip install -e ".[test]"
+    - name: Run tests
+      run: pytest model_card_toolkit

CONTRIBUTING.md

@@ -1,28 +1,168 @@
-# How to Contribute
+# Contribute to Model Card Toolkit
 
-We'd love to accept your patches and contributions to this project. There are
-just a few small guidelines you need to follow.
+Model Card Toolkit can only grow through the contributions of this community.
+Thanks so much for your enthusiasm and your work—we appreciate everything you do!
 
-## Contributor License Agreement
+There are many ways to contribute to Model Card Toolkit! You can contribute code,
+improve tests and API documentation, or create new end-to-end examples. Code
+contributions are not the only way to help the community. Proposing usability
+and design improvements, answering questions, and helping others are also
+immensely valuable.
 
-Contributions to this project must be accompanied by a Contributor License
-Agreement. You (or your employer) retain the copyright to your contribution;
-this simply gives us permission to use and redistribute your contributions as
-part of the project. Head over to <https://cla.developers.google.com/> to see
-your current agreements on file or to sign a new one.
+It also helps us if you spread the word! Reference the library in blog posts
+about the awesome projects it made possible, shout out on social media every
+time it has helped you, or simply star the repository to say thank you.
 
-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.
+For more ways to contribute, refer to GitHub's
+[guide to making open source contributions](https://opensource.guide/how-to-contribute/)
 
-## Code reviews
+**However you choose to contribute, please follow
+[Google's Open Source Community Guidelines](https://opensource.google/conduct/).**
+
+*This guide was heavily inspired by other guides in the
+[Tensorflow GitHub organization](https://github.com/tensorflow) and the
+[🤗 Transformers guide to contributing](https://github.com/huggingface/transformers/blob/main/CONTRIBUTING.md).*
+
+## Contributing Code
+
+If you have improvements to Model Card Toolkit, send us your pull requests!
+Before writing any code, we strongly advise you to search through the existing
+[pull requests](https://github.com/tensorflow/model-card-toolkit/pulls)
+or [issues](https://github.com/tensorflow/model-card-toolkit/issues) to make sure
+nobody is already working on the same thing.
+
+If you would like to contribute code and are not sure where to start, take look
+at issues with the labels
+["good first issue"](https://github.com/tensorflow/model-card-toolkit/labels/good%20first%20issue)
+or ["contributions welcome"](https://github.com/tensorflow/model-card-toolkit/labels/stat%3Acontributions%20welcome).
+
+When you find an issue that you want to work on, please leave a comment so other
+people know you're working on it. If you need help or would prefer to work on the
+issue with others, you may use the issue comment thread ask questions or coordinate.
+
+### 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.
+use GitHub pull requests for this purpose. For those just getting started, GitHub
+has a [pull requests guide](https://help.github.com/articles/using-pull-requests/).
+
+Before submitting your pull request for review, make sure your changes follow the
+Model Card Toolkit guidelines and coding style. Maintainers and other contributors
+will review your pull request. Please participate in the discussion and make the
+requested changes.
+
+### Contributor License Agreements
+
+We'd love to accept your patches! Before we can take them, we have to jump
+a couple of legal hurdles.
+
+Please fill out either the individual or corporate Contributor License Agreement (CLA).
+
+- If you are an individual writing original source code and you're sure you own the
+  intellectual property, then you'll need to sign an
+  [individual CLA](https://code.google.com/legal/individual-cla-v1.0.html).
+- If you work for a company that wants to allow you to contribute your work, then you'll
+  need to sign a [corporate CLA](https://code.google.com/legal/corporate-cla-v1.0.html).
+
+Follow either of the two links above to access the appropriate CLA and instructions
+for how to sign and return it. Once we receive it, we'll be able to accept your pull
+requests.
+
+***NOTE***: Only original source code from you and other people that have signed the
+CLA can be accepted into the main repository.
+
+### Setting up a local development environment
+
+Follow these steps to install `model-card-toolkit`:
+
+1. Install [Bazel](https://bazel.build/install), which powers the protobuf stub
+   code generation. Confirm that Bazel is installed and executable:
+
+   ```sh
+   bazel --version
+   ```
+
+2. Fork the [repository](https://github.com/tensorflow/model-card-toolkit) by
+   clicking on the **[Fork](https://github.com/tensorflow/model-card-toolkit/fork)**
+   button on the repository's page. This creates a copy of the code under your
+   GitHub user account.
+
+3. Clone your fork to your local machine:
+
+   ```sh
+   git clone git@github.com:<your GitHub username>/model-card-toolkit.git
+   cd model-card-toolkit
+   ```
+
+4. Create and activate a virtual environment:
+
+   ```sh
+   python3 -m venv env
+   source env/bin/activate
+   pip install --upgrade pip
+   ```
+
+5. Install the `model-card-toolkit` development package in editable mode:
+
+   ```sh
+   pip install -e ".[test]"
+   ```
+
+   When you install the library in editable mode (with the `-e` flag), your local
+   changes will be picked up without needing to re-install the library.
+
+### Re-generating protobuf stub code
+
+If you make changes to a `.proto` file, you should re-generate the
+protobuf stub code before using it. The command used to do this is
+automatically invoked once when you first install `model-card-toolkit` in
+editable mode, but further stub generation requires manual invocation.
+
+```sh
+bazel run //model_card_toolkit:move_generated_files
+```
+
+### Licenses
+
+Include a license at the top of new files.
+
+- [Python license example](https://github.com/tensorflow/model-card-toolkit/blob/master/setup.py#L1)
+- [Bash license example](https://github.com/tensorflow/model-card-toolkit/blob/master/model_card_toolkit/move_generated_files.sh#L2)
+
+Bazel BUILD files also need to include a license section. See
+[BUILD example](https://github.com/tensorflow/model-card-toolkit/blob/master/model_card_toolkit/BUILD#L15).
+
+**Do not** include a license at the top of Jinja template files.
+
+### Python coding style
+
+Changes to Model Card Toolkit Python code should conform to the
+[Google Python Style Guide](https://github.com/google/styleguide/blob/gh-pages/pyguide.md)
+with indentation width of 2 spaces.
+
+### Testing your changes
+
+#### Writing and updating unit tests
+
+Include unit tests when you contribute new features, as they help to a) prove
+that your code works correctly, and b) guard against future breaking
+changes to lower maintenance costs. Bug fixes also generally require creating
+or updating unit tests, because the presence of bugs usually indicates insufficient
+test coverage.
+
+In general, all Python files have at least one corresponding test file. For example,
+`awesome.py` should have a corresponding `awesome_test.py`.
+
+#### Running unit tests
+
+To run a specific test suite, e.g. `ModelCardTest`, run its test file:
+
+```sh
+pytest model_card_toolkit/model_card_test.py
+```
 
-## Community Guidelines
+Use the following command to run all unit tests:
 
-This project follows [Google's Open Source Community
-Guidelines](https://opensource.google/conduct/).
+```sh
+pytest model_card_toolkit
+```

pyproject.toml

@@ -0,0 +1,7 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.pytest.ini_options]
+addopts = "--verbose"
+python_files = "*_test.py"

setup.py

@@ -37,10 +37,13 @@
     'tensorflow-model-analysis>=0.36.0,<0.42.0',
     'tensorflow-metadata>=1.5.0,<2.0.0',
     'ml-metadata>=1.5.0,<2.0.0',
-    'dataclasses;python_version<"3.7"',
 ]
 
-TESTS_REQUIRE = ['tensorflow-datasets']
+TESTS_REQUIRE = [
+    'pytest',
+    'tensorflow-datasets',
+]
+
 EXTRAS_REQUIRE = {'test':  TESTS_REQUIRE}
 
 # Get version from version module.
@@ -123,7 +126,7 @@ def run(self):
     package_data={
         'model_card_toolkit': ['schema/**/*.json', 'template/**/*.jinja']
     },
-    python_requires='>=3.6,<4',
+    python_requires='>=3.7,<4',
     install_requires=REQUIRED_PACKAGES,
     tests_require=TESTS_REQUIRE,
     extras_require=EXTRAS_REQUIRE,
@@ -137,7 +140,8 @@ def run(self):
         'Operating System :: OS Independent',
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3 :: Only',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
         'Topic :: Scientific/Engineering',
         'Topic :: Scientific/Engineering :: Mathematics',
         'Topic :: Scientific/Engineering :: Artificial Intelligence',