chore: update repo-metadata and regenerate README from templates (#55)

googleapis · Feb 20, 2020 · 741a38c · 741a38c
1 parent 8d4bff0
commit 741a38c
Show file tree

Hide file tree

Showing 3 changed files with 114 additions and 82 deletions.
diff --git a/.repo-metadata.json b/.repo-metadata.json
@@ -2,12 +2,15 @@
   "name": "vision",
   "name_pretty": "Cloud Vision",
   "product_documentation": "https://cloud.google.com/vision/docs/",
-  "client_documentation": "https://googleapis.dev/java/java-vision/latest",
+  "client_documentation": "https://googleapis.dev/java/google-cloud-vision/latest/",
   "issue_tracker": "https://issuetracker.google.com/issues?q=status:open%20componentid:187174",
   "release_level": "ga",
   "language": "java",
   "repo": "googleapis/java-vision",
   "repo_short": "java-vision",
   "distribution_name": "com.google.cloud:google-cloud-vision",
-  "api_id": "vision.googleapis.com"
+  "api_id": "vision.googleapis.com",
+  "transport": "grpc",
+  "requires_billing": true,
+  "api_description": "allows developers to easily integrate vision detection features within applications, including image labeling, face and landmark detection, optical character recognition (OCR), and tagging of explicit content."
 }
diff --git a/README.md b/README.md
@@ -1,46 +1,49 @@
-Google Cloud Java Client for Vision
-======================================
+# Google Cloud Vision Client for Java
 
-Java idiomatic client for [Google Cloud Vision][cloud-vision].
+Java idiomatic client for [Cloud Vision][product-docs].
 
-[![Kokoro CI](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.svg)](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.html)
-[![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-vision.svg)](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-vision.svg)
-[![Codacy Badge](https://api.codacy.com/project/badge/grade/9da006ad7c3a4fe1abd142e77c003917)](https://www.codacy.com/app/mziccard/google-cloud-java)
+[![Maven][maven-version-image]][maven-version-link]
+![Stability][stability-image]
 
-- [Product Documentation][vision-product-docs]
-- [Client Library Documentation][vision-client-lib-docs]
+- [Product Documentation][product-docs]
+- [Client Library Documentation][javadocs]
 
-Quickstart
-----------
+## Quickstart
 
-If you are using Maven with a BOM, add this to your pom.xml file.
+If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
 ```xml
 <dependencyManagement>
- <dependencies>
-  <dependency>
-    <groupId>com.google.cloud</groupId>
-    <artifactId>libraries-bom</artifactId>
-    <version>2.8.0</version>
-    <type>pom</type>
-    <scope>import</scope>
-   </dependency>
- </dependencies>
+  <dependencies>
+    <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>libraries-bom</artifactId>
+      <version>3.5.0</version>
+      <type>pom</type>
+      <scope>import</scope>
+    </dependency>
+  </dependencies>
 </dependencyManagement>
 
-<dependency>
-  <groupId>com.google.cloud</groupId>
-  <artifactId>google-cloud-vision</artifactId>
-</dependency>
+<dependencies>
+  <dependency>
+    <groupId>com.google.cloud</groupId>
+    <artifactId>google-cloud-vision</artifactId>
+  </dependency>
+</dependencies>
 ```
+
 [//]: # ({x-version-update-start:google-cloud-vision:released})
-If you are using Maven without a BOM, add this to your dependencies.
+
+If you are using Maven without BOM, add this to your dependencies:
+
 ```xml
 <dependency>
   <groupId>com.google.cloud</groupId>
   <artifactId>google-cloud-vision</artifactId>
   <version>1.99.1</version>
 </dependency>
 ```
+
 If you are using Gradle, add this to your dependencies
 ```Groovy
 compile 'com.google.cloud:google-cloud-vision:1.99.1'
@@ -51,72 +54,102 @@ libraryDependencies += "com.google.cloud" % "google-cloud-vision" % "1.99.1"
 ```
 [//]: # ({x-version-update-end})
 
-Authentication
---------------
+## Authentication
 
-See the [Authentication](https://github.com/googleapis/google-cloud-java#authentication) section in the base directory's README.
+See the [Authentication][authentication] section in the base directory's README.
 
-About Google Cloud Vision
-----------------------------
+## Getting Started
 
-Google [Cloud Vision API][cloud-vision] allows developers to easily integrate vision detection features within applications, including image labeling, face and landmark detection, optical character recognition (OCR), and tagging of explicit content.
+### Prerequisites
 
-See the [Vision client library docs][vision-client-lib-docs] to learn how to use this Cloud Vision API Client Library.
+You will need a [Google Cloud Platform Console][developer-console] project with the Cloud Vision [API enabled][enable-api].
+You will need to [enable billing][enable-billing] to use Google Cloud Vision.
+[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
+[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
+`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
 
-Getting Started
----------------
-#### Prerequisites
-You will need a [Google Developers Console](https://console.developers.google.com/) project with the Vision API enabled. [Follow these instructions](https://cloud.google.com/resource-manager/docs/creating-managing-projects) to get your project set up. You will also need to set up the local development environment by [installing the Google Cloud SDK](https://cloud.google.com/sdk/) and running the following commands in command line: `gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
+### Installation and setup
 
-#### Installation and setup
-You'll need to obtain the `google-cloud-vision` library.  See the [Quickstart](#quickstart) section to add `google-cloud-vision` as a dependency in your code.
+You'll need to obtain the `google-cloud-vision` library.  See the [Quickstart](#quickstart) section
+to add `google-cloud-vision` as a dependency in your code.
 
-#### Complete working example
+## About Cloud Vision
 
-In [AnnotateImage.java](../../google-cloud-examples/src/main/java/com/google/cloud/examples/vision/snippets/AnnotateImage.java) we put a quick start example, which shows how you can use the Google Vision API to automatically annotate an image (like "cat", "whiskers", "mammal" for a picture of a cat).
 
-For an example picture file, you can use the [wakeupcat.jpg](https://github.com/GoogleCloudPlatform/java-docs-samples/blob/master/vision/cloud-client/resources/wakeupcat.jpg) image from the samples repository.
+[Cloud Vision][product-docs] allows developers to easily integrate vision detection features within applications, including image labeling, face and landmark detection, optical character recognition (OCR), and tagging of explicit content.
 
-Troubleshooting
----------------
+See the [Cloud Vision client library docs][javadocs] to learn how to
+use this Cloud Vision Client Library.
 
-To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting).
 
-Transport
----------
-Vision uses gRPC for the transport layer.
 
-Java Versions
--------------
 
-Java 7 or above is required for using this client.
+## Troubleshooting
 
-Versioning
-----------
+To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
 
-This library follows [Semantic Versioning](http://semver.org/).
+## Transport
 
-It is currently in major version one (``1.y.z``), which means that the public API should be considered stable.
+Cloud Vision uses gRPC for the transport layer.
 
-Contributing
-------------
+## Java Versions
 
-Contributions to this library are always welcome and highly encouraged.
+Java 7 or above is required for using this client.
+
+## Versioning
 
-See `google-cloud`'s [CONTRIBUTING] documentation and the [shared documentation](https://github.com/googleapis/google-cloud-common/blob/master/contributing/readme.md#how-to-contribute-to-gcloud) for more information on how to get started.
+This library follows [Semantic Versioning](http://semver.org/).
 
-Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more information.
 
-License
--------
 
-Apache 2.0 - See [LICENSE] for more information.
+## Contributing
 
 
-[CONTRIBUTING]:https://github.com/googleapis/google-cloud-java/blob/master/CONTRIBUTING.md
-[code-of-conduct]:https://github.com/googleapis/google-cloud-java/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
-[LICENSE]: https://github.com/googleapis/google-cloud-java/blob/master/LICENSE
-[cloud-platform]: https://cloud.google.com/
-[cloud-vision]: https://cloud.google.com/vision/
-[vision-product-docs]: https://cloud.google.com/vision/docs
-[vision-client-lib-docs]: https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/vision/v1/package-summary.html
+Contributions to this library are always welcome and highly encouraged.
+
+See [CONTRIBUTING][contributing] for more information how to get started.
+
+Please note that this project is released with a Contributor Code of Conduct. By participating in
+this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
+information.
+
+## License
+
+Apache 2.0 - See [LICENSE][license] for more information.
+
+## CI Status
+
+Java Version | Status
+------------ | ------
+Java 7 | [![Kokoro CI][kokoro-badge-image-1]][kokoro-badge-link-1]
+Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2]
+Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
+Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
+Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
+
+[product-docs]: https://cloud.google.com/vision/docs/
+[javadocs]: https://googleapis.dev/java/google-cloud-vision/latest/
+[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-vision/java7.svg
+[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-vision/java7.html
+[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-vision/java8.svg
+[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-vision/java8.html
+[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-vision/java8-osx.svg
+[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-vision/java8-osx.html
+[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-vision/java8-win.svg
+[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-vision/java8-win.html
+[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-vision/java11.svg
+[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-vision/java11.html
+[stability-image]: https://img.shields.io/badge/stability-ga-green
+[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-vision.svg
+[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-vision&core=gav
+[authentication]: https://github.com/googleapis/google-cloud-java#authentication
+[developer-console]: https://console.developers.google.com/
+[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
+[cloud-sdk]: https://cloud.google.com/sdk/
+[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting
+[contributing]: https://github.com/googleapis/java-vision/blob/master/CONTRIBUTING.md
+[code-of-conduct]: https://github.com/googleapis/java-vision/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
+[license]: https://github.com/googleapis/java-vision/blob/master/LICENSE
+[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
+[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=vision.googleapis.com
+[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
diff --git a/synth.py b/synth.py
@@ -25,15 +25,11 @@
 config_pattern = '/google/cloud/vision/artman_vision_{version}.yaml'
 
 for version in versions:
-    java.gapic_library(
-        service=service,
-        version=version,
-        config_pattern=config_pattern,
-        gapic=gapic,
-    )
+  java.gapic_library(
+    service=service,
+    version=version,
+    config_pattern=config_pattern,
+    gapic=gapic,
+  )
 
-common_templates = gcp.CommonTemplates()
-templates = common_templates.java_library()
-s.copy(templates, excludes=[
-  'README.md',
-])
+java.common_templates()