Skip to content
This repository has been archived by the owner on Sep 16, 2023. It is now read-only.

feat: promote to beta #64

Merged
merged 1 commit into from Jan 24, 2020
Merged

feat: promote to beta #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions .repo-metadata.json
View file
Open in desktop
@@ -1,11 +1,13 @@
{
"name": "datalabeling",
"name_pretty": "Google Cloud Data Labeling",
"product_documentation": "https://cloud.google.com/data-labeling/docs/",
"client_documentation": "https://googleapis.dev/java/java-datalabeling/latest/index.html",
"product_documentation": "https://cloud.google.com/ai-platform/data-labeling/docs/",
"client_documentation": "https://googleapis.dev/java/google-cloud-datalabeling/latest/index.html",
"api_description": "",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM I'd add an issue to track to add this in

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opened https://github.com/googleapis/java-datalabeling/issues/65 to track

"issue_tracker": "",
"release_level": "alpha",
"release_level": "beta",
"language": "java",
"transport": "grpc",
"repo": "googleapis/java-datalabeling",
"repo_short": "java-datalabeling",
"distribution_name": "com.google.cloud:google-cloud-datalabeling",
Expand Down
169 changes: 104 additions & 65 deletions README.md
View file
Open in desktop
@@ -1,48 +1,52 @@
Google Cloud Java Client for Cloud Data Labeling
===================================================
# Google Google Cloud Data Labeling Client for Java

Java idiomatic client for [Cloud Data Labeling][cloud-datalabeling].
Java idiomatic client for [Google Cloud Data Labeling][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-datalabeling.svg)](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-datalabeling.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][datalabeling-product-docs]
- [Client Library Documentation][datalabeling-lib-docs]
- [Product Documentation][product-docs]
- [Client Library Documentation][javadocs]

> Note: This client is a work-in-progress, and may occasionally
> make backwards-incompatible changes.

Quickstart
----------
If you are using Maven with Bom, Add this to your pom.xml file.
## Quickstart

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.4.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-datalabeling</artifactId>
</dependency>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-datalabeling</artifactId>
</dependency>
</dependencies>
```

[//]: # ({x-version-update-start:google-cloud-datalabeling:released})
If you are using Maven without 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-datalabeling</artifactId>
<version>0.116.3-alpha</version>
</dependency>
```

If you are using Gradle, add this to your dependencies
```Groovy
compile 'com.google.cloud:google-cloud-datalabeling:0.116.3-alpha'
Expand All @@ -53,64 +57,99 @@ libraryDependencies += "com.google.cloud" % "google-cloud-datalabeling" % "0.116
```
[//]: # ({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 Cloud Labeling
----------------------------
## Getting Started

See the [Cloud Data Labeling client library docs][datalabeling-lib-docs] to learn how to use this Cloud Data Labeling Client Library.
### Prerequisites

Getting Started
---------------
#### Prerequisites
You will need a [Google Developers Console](https://console.developers.google.com/) project with the Cloud Data Labeling 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]`.
You will need a [Google Cloud Platform Console][developer-console] project with the Google Cloud Data Labeling [API enabled][enable-api].

#### Installation and setup
You'll need to obtain the `google-cloud-datalabeling` library. See the [Quickstart](#quickstart) section to add `google-cloud-datalabeling` as a dependency in your code.
[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]`.

Troubleshooting
---------------
### Installation and setup

To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting).
You'll need to obtain the `google-cloud-datalabeling` library. See the [Quickstart](#quickstart) section
to add `google-cloud-datalabeling` as a dependency in your code.

Transport
---------
Cloud Data Labeling uses gRPC for the transport layer.
## About Google Cloud Data Labeling

Java Versions
-------------
See the [Google Cloud Data Labeling client library docs][javadocs] to learn how to
use this Google Cloud Data Labeling Client Library.

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 zero (``0.y.z``), which means that anything may change at any time and the public API should not be considered stable.
Google Cloud Data Labeling 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.

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.
## Versioning

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.
This library follows [Semantic Versioning](http://semver.org/).


It is currently in major version zero (``0.y.z``), which means that anything may change at any time
and the public API should not be considered stable.

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-datalabeling]: http://cloud.google.com/data-labeling/docs/
[datalabeling-product-docs]: http://cloud.google.com/data-labeling/docs/
[datalabeling-lib-docs]: https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/datalabeling/v1beta1/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/ai-platform/data-labeling/docs/
[javadocs]: https://googleapis.dev/java/google-cloud-datalabeling/latest/index.html
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java7.svg
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java7.html
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java8.svg
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java8.html
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java8-osx.svg
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java8-osx.html
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java8-win.svg
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java8-win.html
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java11.svg
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-datalabeling/java11.html
[stability-image]: https://img.shields.io/badge/stability-beta-yellow
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-datalabeling.svg
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-datalabeling&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-datalabeling/blob/master/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/java-datalabeling/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/java-datalabeling/blob/master/LICENSE

[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=datalabeling.googleapis.com
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM